]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
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> | |
8 | * | |
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. | |
13 | * | |
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. | |
18 | * | |
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/>. | |
21 | */ | |
22 | ||
23 | #include <config.h> | |
24 | ||
25 | #include <libsigrok/libsigrok.h> | |
26 | #include <string.h> | |
27 | ||
28 | #include "libsigrok-internal.h" | |
29 | #include "protocol.h" | |
30 | ||
31 | /* USB PID dependent MCU firmware. Model dependent FPGA bitstream. */ | |
32 | #define MCU_FWFILE_FMT "kingst-la-%04x.fw" | |
33 | #define FPGA_FWFILE_FMT "kingst-%s-fpga.bitstream" | |
34 | ||
35 | /* | |
36 | * List of supported devices and their features. See @ref kingst_model | |
37 | * for the fields' type and meaning. Table is sorted by EEPROM magic. | |
38 | * | |
39 | * TODO | |
40 | * - Below LA1016 properties were guessed, need verification. | |
41 | * - Add LA5016 and LA5032 devices when their EEPROM magic is known. | |
42 | * - Does LA1010 fit the driver implementation? Samplerates vary with | |
43 | * channel counts, lack of local sample memory. Most probably not. | |
44 | */ | |
45 | static const struct kingst_model models[] = { | |
46 | { 2, "LA2016", "la2016", SR_MHZ(200), 16, 1, }, | |
47 | { 3, "LA1016", "la1016", SR_MHZ(100), 16, 1, }, | |
48 | { 8, "LA2016", "la2016a1", SR_MHZ(200), 16, 1, }, | |
49 | { 9, "LA1016", "la1016a1", SR_MHZ(100), 16, 1, }, | |
50 | }; | |
51 | ||
52 | /* USB vendor class control requests, executed by the Cypress FX2 MCU. */ | |
53 | #define CMD_FPGA_ENABLE 0x10 | |
54 | #define CMD_FPGA_SPI 0x20 /* R/W access to FPGA registers via SPI. */ | |
55 | #define CMD_BULK_START 0x30 /* Start sample data download via USB EP6 IN. */ | |
56 | #define CMD_BULK_RESET 0x38 /* Flush FIFO of FX2 USB EP6 IN. */ | |
57 | #define CMD_FPGA_INIT 0x50 /* Used before and after FPGA bitstream upload. */ | |
58 | #define CMD_KAUTH 0x60 /* Communicate to auth IC (U10). Not used. */ | |
59 | #define CMD_EEPROM 0xa2 /* R/W access to EEPROM content. */ | |
60 | ||
61 | /* | |
62 | * FPGA register addresses (base addresses when registers span multiple | |
63 | * bytes, in that case data is kept in little endian format). Passed to | |
64 | * CMD_FPGA_SPI requests. The FX2 MCU transparently handles the detail | |
65 | * of SPI transfers encoding the read (1) or write (0) direction in the | |
66 | * MSB of the address field. There are some 60 byte-wide FPGA registers. | |
67 | * | |
68 | * Unfortunately the FPGA registers change their meaning between the | |
69 | * read and write directions of access, or exclusively provide one of | |
70 | * these directions and not the other. This is an arbitrary vendor's | |
71 | * choice, there is nothing which the sigrok driver could do about it. | |
72 | * Values written to registers typically cannot get read back, neither | |
73 | * verified after writing a configuration, nor queried upon startup for | |
74 | * automatic detection of the current configuration. Neither appear to | |
75 | * be there echo registers for presence and communication checks, nor | |
76 | * version identifying registers, as far as we know. | |
77 | */ | |
78 | #define REG_RUN 0x00 /* Read capture status, write start capture. */ | |
79 | #define REG_PWM_EN 0x02 /* User PWM channels on/off. */ | |
80 | #define REG_CAPT_MODE 0x03 /* Write 0x00 capture to SDRAM, 0x01 streaming. */ | |
81 | #define REG_BULK 0x08 /* Write start addr, byte count to download samples. */ | |
82 | #define REG_SAMPLING 0x10 /* Write capture config, read capture SDRAM location. */ | |
83 | #define REG_TRIGGER 0x20 /* Write level and edge trigger config. */ | |
84 | #define REG_UNKNOWN_30 0x30 | |
85 | #define REG_THRESHOLD 0x68 /* Write PWM config to setup input threshold DAC. */ | |
86 | #define REG_PWM1 0x70 /* Write config for user PWM1. */ | |
87 | #define REG_PWM2 0x78 /* Write config for user PWM2. */ | |
88 | ||
89 | /* Bit patterns to write to REG_RUN, setup run mode. */ | |
90 | #define RUNMODE_HALT 0x00 | |
91 | #define RUNMODE_RUN 0x03 | |
92 | ||
93 | /* Bit patterns when reading from REG_RUN, get run state. */ | |
94 | #define RUNSTATE_IDLE_BIT (1UL << 0) | |
95 | #define RUNSTATE_DRAM_BIT (1UL << 1) | |
96 | #define RUNSTATE_TRGD_BIT (1UL << 2) | |
97 | #define RUNSTATE_POST_BIT (1UL << 3) | |
98 | ||
99 | /* Properties related to the layout of capture data downloads. */ | |
100 | #define NUM_PACKETS_IN_CHUNK 5 | |
101 | #define TRANSFER_PACKET_LENGTH 16 | |
102 | ||
103 | static int ctrl_in(const struct sr_dev_inst *sdi, | |
104 | uint8_t bRequest, uint16_t wValue, uint16_t wIndex, | |
105 | void *data, uint16_t wLength) | |
106 | { | |
107 | struct sr_usb_dev_inst *usb; | |
108 | int ret; | |
109 | ||
110 | usb = sdi->conn; | |
111 | ||
112 | ret = libusb_control_transfer(usb->devhdl, | |
113 | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_IN, | |
114 | bRequest, wValue, wIndex, data, wLength, | |
115 | DEFAULT_TIMEOUT_MS); | |
116 | if (ret != wLength) { | |
117 | sr_dbg("USB ctrl in: %d bytes, req %d val %#x idx %d: %s.", | |
118 | wLength, bRequest, wValue, wIndex, | |
119 | libusb_error_name(ret)); | |
120 | sr_err("Cannot read %d bytes from USB: %s.", | |
121 | wLength, libusb_error_name(ret)); | |
122 | return SR_ERR_IO; | |
123 | } | |
124 | ||
125 | return SR_OK; | |
126 | } | |
127 | ||
128 | static int ctrl_out(const struct sr_dev_inst *sdi, | |
129 | uint8_t bRequest, uint16_t wValue, uint16_t wIndex, | |
130 | void *data, uint16_t wLength) | |
131 | { | |
132 | struct sr_usb_dev_inst *usb; | |
133 | int ret; | |
134 | ||
135 | usb = sdi->conn; | |
136 | ||
137 | ret = libusb_control_transfer(usb->devhdl, | |
138 | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT, | |
139 | bRequest, wValue, wIndex, data, wLength, | |
140 | DEFAULT_TIMEOUT_MS); | |
141 | if (ret != wLength) { | |
142 | sr_dbg("USB ctrl out: %d bytes, req %d val %#x idx %d: %s.", | |
143 | wLength, bRequest, wValue, wIndex, | |
144 | libusb_error_name(ret)); | |
145 | sr_err("Cannot write %d bytes to USB: %s.", | |
146 | wLength, libusb_error_name(ret)); | |
147 | return SR_ERR_IO; | |
148 | } | |
149 | ||
150 | return SR_OK; | |
151 | } | |
152 | ||
153 | /* | |
154 | * Check the necessity for FPGA bitstream upload, because another upload | |
155 | * would take some 600ms which is undesirable after program startup. Try | |
156 | * to access some FPGA registers and check the values' plausibility. The | |
157 | * check should fail on the safe side, request another upload when in | |
158 | * doubt. A positive response (the request to continue operation with the | |
159 | * currently active bitstream) should be conservative. Accessing multiple | |
160 | * registers is considered cheap compared to the cost of bitstream upload. | |
161 | * | |
162 | * It helps though that both the vendor software and the sigrok driver | |
163 | * use the same bundle of MCU firmware and FPGA bitstream for any of the | |
164 | * supported models. We don't expect to successfully communicate to the | |
165 | * device yet disagree on its protocol. Ideally we would access version | |
166 | * identifying registers for improved robustness, but are not aware of | |
167 | * any. A bitstream reload can always be forced by a power cycle. | |
168 | */ | |
169 | static int check_fpga_bitstream(const struct sr_dev_inst *sdi) | |
170 | { | |
171 | uint8_t init_rsp; | |
172 | uint8_t buff[REG_PWM_EN - REG_RUN]; /* Larger of REG_RUN, REG_PWM_EN. */ | |
173 | int ret; | |
174 | uint16_t run_state; | |
175 | uint8_t pwm_en; | |
176 | size_t read_len; | |
177 | const uint8_t *rdptr; | |
178 | ||
179 | sr_dbg("Checking operation of the FPGA bitstream."); | |
180 | ||
181 | init_rsp = ~0; | |
182 | ret = ctrl_in(sdi, CMD_FPGA_INIT, 0x00, 0, &init_rsp, sizeof(init_rsp)); | |
183 | if (ret != SR_OK || init_rsp != 0) { | |
184 | sr_dbg("FPGA init query failed, or unexpected response."); | |
185 | return SR_ERR_IO; | |
186 | } | |
187 | ||
188 | read_len = sizeof(run_state); | |
189 | ret = ctrl_in(sdi, CMD_FPGA_SPI, REG_RUN, 0, buff, read_len); | |
190 | if (ret != SR_OK) { | |
191 | sr_dbg("FPGA register access failed (run state)."); | |
192 | return SR_ERR_IO; | |
193 | } | |
194 | rdptr = buff; | |
195 | run_state = read_u16le_inc(&rdptr); | |
196 | sr_spew("FPGA register: run state 0x%04x.", run_state); | |
197 | if (run_state && (run_state & 0x3) != 0x1) { | |
198 | sr_dbg("Unexpected FPGA register content (run state)."); | |
199 | return SR_ERR_DATA; | |
200 | } | |
201 | if (run_state && (run_state & ~0xf) != 0x85e0) { | |
202 | sr_dbg("Unexpected FPGA register content (run state)."); | |
203 | return SR_ERR_DATA; | |
204 | } | |
205 | ||
206 | read_len = sizeof(pwm_en); | |
207 | ret = ctrl_in(sdi, CMD_FPGA_SPI, REG_PWM_EN, 0, buff, read_len); | |
208 | if (ret != SR_OK) { | |
209 | sr_dbg("FPGA register access failed (PWM enable)."); | |
210 | return SR_ERR_IO; | |
211 | } | |
212 | rdptr = buff; | |
213 | pwm_en = read_u8_inc(&rdptr); | |
214 | sr_spew("FPGA register: PWM enable 0x%02x.", pwm_en); | |
215 | if ((pwm_en & 0x3) != 0x0) { | |
216 | sr_dbg("Unexpected FPGA register content (PWM enable)."); | |
217 | return SR_ERR_DATA; | |
218 | } | |
219 | ||
220 | sr_info("Could re-use current FPGA bitstream. No upload required."); | |
221 | return SR_OK; | |
222 | } | |
223 | ||
224 | static int upload_fpga_bitstream(const struct sr_dev_inst *sdi, | |
225 | const char *bitstream_fname) | |
226 | { | |
227 | struct drv_context *drvc; | |
228 | struct sr_usb_dev_inst *usb; | |
229 | struct sr_resource bitstream; | |
230 | uint32_t bitstream_size; | |
231 | uint8_t buffer[sizeof(uint32_t)]; | |
232 | uint8_t *wrptr; | |
233 | uint8_t block[4096]; | |
234 | int len, act_len; | |
235 | unsigned int pos; | |
236 | int ret; | |
237 | unsigned int zero_pad_to; | |
238 | ||
239 | drvc = sdi->driver->context; | |
240 | usb = sdi->conn; | |
241 | ||
242 | sr_info("Uploading FPGA bitstream '%s'.", bitstream_fname); | |
243 | ||
244 | ret = sr_resource_open(drvc->sr_ctx, &bitstream, | |
245 | SR_RESOURCE_FIRMWARE, bitstream_fname); | |
246 | if (ret != SR_OK) { | |
247 | sr_err("Cannot find FPGA bitstream %s.", bitstream_fname); | |
248 | return ret; | |
249 | } | |
250 | ||
251 | bitstream_size = (uint32_t)bitstream.size; | |
252 | wrptr = buffer; | |
253 | write_u32le_inc(&wrptr, bitstream_size); | |
254 | ret = ctrl_out(sdi, CMD_FPGA_INIT, 0x00, 0, buffer, wrptr - buffer); | |
255 | if (ret != SR_OK) { | |
256 | sr_err("Cannot initiate FPGA bitstream upload."); | |
257 | sr_resource_close(drvc->sr_ctx, &bitstream); | |
258 | return ret; | |
259 | } | |
260 | zero_pad_to = bitstream_size; | |
261 | zero_pad_to += LA2016_EP2_PADDING - 1; | |
262 | zero_pad_to /= LA2016_EP2_PADDING; | |
263 | zero_pad_to *= LA2016_EP2_PADDING; | |
264 | ||
265 | pos = 0; | |
266 | while (1) { | |
267 | if (pos < bitstream.size) { | |
268 | len = (int)sr_resource_read(drvc->sr_ctx, &bitstream, | |
269 | block, sizeof(block)); | |
270 | if (len < 0) { | |
271 | sr_err("Cannot read FPGA bitstream."); | |
272 | sr_resource_close(drvc->sr_ctx, &bitstream); | |
273 | return SR_ERR_IO; | |
274 | } | |
275 | } else { | |
276 | /* Zero-pad until 'zero_pad_to'. */ | |
277 | len = zero_pad_to - pos; | |
278 | if ((unsigned)len > sizeof(block)) | |
279 | len = sizeof(block); | |
280 | memset(&block, 0, len); | |
281 | } | |
282 | if (len == 0) | |
283 | break; | |
284 | ||
285 | ret = libusb_bulk_transfer(usb->devhdl, USB_EP_FPGA_BITSTREAM, | |
286 | &block[0], len, &act_len, DEFAULT_TIMEOUT_MS); | |
287 | if (ret != 0) { | |
288 | sr_dbg("Cannot write FPGA bitstream, block %#x len %d: %s.", | |
289 | pos, (int)len, libusb_error_name(ret)); | |
290 | ret = SR_ERR_IO; | |
291 | break; | |
292 | } | |
293 | if (act_len != len) { | |
294 | sr_dbg("Short write for FPGA bitstream, block %#x len %d: got %d.", | |
295 | pos, (int)len, act_len); | |
296 | ret = SR_ERR_IO; | |
297 | break; | |
298 | } | |
299 | pos += len; | |
300 | } | |
301 | sr_resource_close(drvc->sr_ctx, &bitstream); | |
302 | if (ret != SR_OK) | |
303 | return ret; | |
304 | sr_info("FPGA bitstream upload (%" PRIu64 " bytes) done.", | |
305 | bitstream.size); | |
306 | ||
307 | return SR_OK; | |
308 | } | |
309 | ||
310 | static int enable_fpga_bitstream(const struct sr_dev_inst *sdi) | |
311 | { | |
312 | int ret; | |
313 | uint8_t resp; | |
314 | ||
315 | ret = ctrl_in(sdi, CMD_FPGA_INIT, 0x00, 0, &resp, sizeof(resp)); | |
316 | if (ret != SR_OK) { | |
317 | sr_err("Cannot read response after FPGA bitstream upload."); | |
318 | return ret; | |
319 | } | |
320 | if (resp != 0) { | |
321 | sr_err("Unexpected FPGA bitstream upload response, got 0x%02x, want 0.", | |
322 | resp); | |
323 | return SR_ERR_DATA; | |
324 | } | |
325 | g_usleep(30 * 1000); | |
326 | ||
327 | ret = ctrl_out(sdi, CMD_FPGA_ENABLE, 0x01, 0, NULL, 0); | |
328 | if (ret != SR_OK) { | |
329 | sr_err("Cannot enable FPGA after bitstream upload."); | |
330 | return ret; | |
331 | } | |
332 | g_usleep(40 * 1000); | |
333 | ||
334 | return SR_OK; | |
335 | } | |
336 | ||
337 | static int set_threshold_voltage(const struct sr_dev_inst *sdi, float voltage) | |
338 | { | |
339 | int ret; | |
340 | uint16_t duty_R79, duty_R56; | |
341 | uint8_t buf[REG_PWM1 - REG_THRESHOLD]; /* Width of REG_THRESHOLD. */ | |
342 | uint8_t *wrptr; | |
343 | ||
344 | /* Clamp threshold setting to valid range for LA2016. */ | |
345 | if (voltage > LA2016_THR_VOLTAGE_MAX) { | |
346 | voltage = LA2016_THR_VOLTAGE_MAX; | |
347 | } else if (voltage < -LA2016_THR_VOLTAGE_MAX) { | |
348 | voltage = -LA2016_THR_VOLTAGE_MAX; | |
349 | } | |
350 | ||
351 | /* | |
352 | * Two PWM output channels feed one DAC which generates a bias | |
353 | * voltage, which offsets the input probe's voltage level, and | |
354 | * in combination with the FPGA pins' fixed threshold result in | |
355 | * a programmable input threshold from the user's perspective. | |
356 | * The PWM outputs can be seen on R79 and R56 respectively, the | |
357 | * frequency is 100kHz and the duty cycle varies. The R79 PWM | |
358 | * uses three discrete settings. The R56 PWM varies with desired | |
359 | * thresholds and depends on the R79 PWM configuration. See the | |
360 | * schematics comments which discuss the formulae. | |
361 | */ | |
362 | if (voltage >= 2.9) { | |
363 | duty_R79 = 0; /* PWM off (0V). */ | |
364 | duty_R56 = (uint16_t)(302 * voltage - 363); | |
365 | } else if (voltage > -0.4) { | |
366 | duty_R79 = 0x00f2; /* 25% duty cycle. */ | |
367 | duty_R56 = (uint16_t)(302 * voltage + 121); | |
368 | } else { | |
369 | duty_R79 = 0x02d7; /* 72% duty cycle. */ | |
370 | duty_R56 = (uint16_t)(302 * voltage + 1090); | |
371 | } | |
372 | ||
373 | /* Clamp duty register values to sensible limits. */ | |
374 | if (duty_R56 < 10) { | |
375 | duty_R56 = 10; | |
376 | } else if (duty_R56 > 1100) { | |
377 | duty_R56 = 1100; | |
378 | } | |
379 | ||
380 | sr_dbg("Set threshold voltage %.2fV.", voltage); | |
381 | sr_dbg("Duty cycle values: R56 0x%04x, R79 0x%04x.", duty_R56, duty_R79); | |
382 | ||
383 | wrptr = buf; | |
384 | write_u16le_inc(&wrptr, duty_R56); | |
385 | write_u16le_inc(&wrptr, duty_R79); | |
386 | ||
387 | ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_THRESHOLD, 0, buf, wrptr - buf); | |
388 | if (ret != SR_OK) { | |
389 | sr_err("Cannot set threshold voltage %.2fV.", voltage); | |
390 | return ret; | |
391 | } | |
392 | ||
393 | return SR_OK; | |
394 | } | |
395 | ||
396 | /* | |
397 | * Communicates a channel's configuration to the device after the | |
398 | * parameters may have changed. Configuration of one channel may | |
399 | * interfere with other channels since they share FPGA registers. | |
400 | */ | |
401 | static int set_pwm_config(const struct sr_dev_inst *sdi, size_t idx) | |
402 | { | |
403 | static uint8_t reg_bases[] = { REG_PWM1, REG_PWM2, }; | |
404 | ||
405 | struct dev_context *devc; | |
406 | struct pwm_setting *params; | |
407 | uint8_t reg_base; | |
408 | double val_f; | |
409 | uint32_t val_u; | |
410 | uint32_t period, duty; | |
411 | size_t ch; | |
412 | int ret; | |
413 | uint8_t enable_all, enable_cfg, reg_val; | |
414 | uint8_t buf[REG_PWM2 - REG_PWM1]; /* Width of one REG_PWMx. */ | |
415 | uint8_t *wrptr; | |
416 | ||
417 | devc = sdi->priv; | |
418 | if (idx >= ARRAY_SIZE(devc->pwm_setting)) | |
419 | return SR_ERR_ARG; | |
420 | params = &devc->pwm_setting[idx]; | |
421 | if (idx >= ARRAY_SIZE(reg_bases)) | |
422 | return SR_ERR_ARG; | |
423 | reg_base = reg_bases[idx]; | |
424 | ||
425 | /* | |
426 | * Map application's specs to hardware register values. Do math | |
427 | * in floating point initially, but convert to u32 eventually. | |
428 | */ | |
429 | sr_dbg("PWM config, app spec, ch %zu, en %d, freq %.1f, duty %.1f.", | |
430 | idx, params->enabled ? 1 : 0, params->freq, params->duty); | |
431 | val_f = PWM_CLOCK; | |
432 | val_f /= params->freq; | |
433 | val_u = val_f; | |
434 | period = val_u; | |
435 | val_f = period; | |
436 | val_f *= params->duty; | |
437 | val_f /= 100.0; | |
438 | val_f += 0.5; | |
439 | val_u = val_f; | |
440 | duty = val_u; | |
441 | sr_dbg("PWM config, reg 0x%04x, freq %u, duty %u.", | |
442 | (unsigned)reg_base, (unsigned)period, (unsigned)duty); | |
443 | ||
444 | /* Get the "enabled" state of all supported PWM channels. */ | |
445 | enable_all = 0; | |
446 | for (ch = 0; ch < ARRAY_SIZE(devc->pwm_setting); ch++) { | |
447 | if (!devc->pwm_setting[ch].enabled) | |
448 | continue; | |
449 | enable_all |= 1U << ch; | |
450 | } | |
451 | enable_cfg = 1U << idx; | |
452 | sr_spew("PWM config, enable all 0x%02hhx, cfg 0x%02hhx.", | |
453 | enable_all, enable_cfg); | |
454 | ||
455 | /* | |
456 | * Disable the to-get-configured channel before its parameters | |
457 | * will change. Or disable and exit when the channel is supposed | |
458 | * to get turned off. | |
459 | */ | |
460 | sr_spew("PWM config, disabling before param change."); | |
461 | reg_val = enable_all & ~enable_cfg; | |
462 | ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_PWM_EN, 0, | |
463 | ®_val, sizeof(reg_val)); | |
464 | if (ret != SR_OK) { | |
465 | sr_err("Cannot adjust PWM enabled state."); | |
466 | return ret; | |
467 | } | |
468 | if (!params->enabled) | |
469 | return SR_OK; | |
470 | ||
471 | /* Write register values to device. */ | |
472 | sr_spew("PWM config, sending new parameters."); | |
473 | wrptr = buf; | |
474 | write_u32le_inc(&wrptr, period); | |
475 | write_u32le_inc(&wrptr, duty); | |
476 | ret = ctrl_out(sdi, CMD_FPGA_SPI, reg_base, 0, buf, wrptr - buf); | |
477 | if (ret != SR_OK) { | |
478 | sr_err("Cannot change PWM parameters."); | |
479 | return ret; | |
480 | } | |
481 | ||
482 | /* Enable configured channel after write completion. */ | |
483 | sr_spew("PWM config, enabling after param change."); | |
484 | reg_val = enable_all | enable_cfg; | |
485 | ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_PWM_EN, 0, | |
486 | ®_val, sizeof(reg_val)); | |
487 | if (ret != SR_OK) { | |
488 | sr_err("Cannot adjust PWM enabled state."); | |
489 | return ret; | |
490 | } | |
491 | ||
492 | return SR_OK; | |
493 | } | |
494 | ||
495 | static uint16_t get_channels_mask(const struct sr_dev_inst *sdi) | |
496 | { | |
497 | uint16_t channels; | |
498 | GSList *l; | |
499 | struct sr_channel *ch; | |
500 | ||
501 | channels = 0; | |
502 | for (l = sdi->channels; l; l = l->next) { | |
503 | ch = l->data; | |
504 | if (ch->type != SR_CHANNEL_LOGIC) | |
505 | continue; | |
506 | if (!ch->enabled) | |
507 | continue; | |
508 | channels |= 1UL << ch->index; | |
509 | } | |
510 | ||
511 | return channels; | |
512 | } | |
513 | ||
514 | static int set_trigger_config(const struct sr_dev_inst *sdi) | |
515 | { | |
516 | struct dev_context *devc; | |
517 | struct sr_trigger *trigger; | |
518 | struct trigger_cfg { | |
519 | uint32_t channels; | |
520 | uint32_t enabled; | |
521 | uint32_t level; | |
522 | uint32_t high_or_falling; | |
523 | } cfg; | |
524 | GSList *stages; | |
525 | GSList *channel; | |
526 | struct sr_trigger_stage *stage1; | |
527 | struct sr_trigger_match *match; | |
528 | uint16_t ch_mask; | |
529 | int ret; | |
530 | uint8_t buf[REG_UNKNOWN_30 - REG_TRIGGER]; /* Width of REG_TRIGGER. */ | |
531 | uint8_t *wrptr; | |
532 | ||
533 | devc = sdi->priv; | |
534 | trigger = sr_session_trigger_get(sdi->session); | |
535 | ||
536 | memset(&cfg, 0, sizeof(cfg)); | |
537 | ||
538 | cfg.channels = get_channels_mask(sdi); | |
539 | ||
540 | if (trigger && trigger->stages) { | |
541 | stages = trigger->stages; | |
542 | stage1 = stages->data; | |
543 | if (stages->next) { | |
544 | sr_err("Only one trigger stage supported for now."); | |
545 | return SR_ERR_ARG; | |
546 | } | |
547 | channel = stage1->matches; | |
548 | while (channel) { | |
549 | match = channel->data; | |
550 | ch_mask = 1UL << match->channel->index; | |
551 | ||
552 | switch (match->match) { | |
553 | case SR_TRIGGER_ZERO: | |
554 | cfg.level |= ch_mask; | |
555 | cfg.high_or_falling &= ~ch_mask; | |
556 | break; | |
557 | case SR_TRIGGER_ONE: | |
558 | cfg.level |= ch_mask; | |
559 | cfg.high_or_falling |= ch_mask; | |
560 | break; | |
561 | case SR_TRIGGER_RISING: | |
562 | if ((cfg.enabled & ~cfg.level)) { | |
563 | sr_err("Device only supports one edge trigger."); | |
564 | return SR_ERR_ARG; | |
565 | } | |
566 | cfg.level &= ~ch_mask; | |
567 | cfg.high_or_falling &= ~ch_mask; | |
568 | break; | |
569 | case SR_TRIGGER_FALLING: | |
570 | if ((cfg.enabled & ~cfg.level)) { | |
571 | sr_err("Device only supports one edge trigger."); | |
572 | return SR_ERR_ARG; | |
573 | } | |
574 | cfg.level &= ~ch_mask; | |
575 | cfg.high_or_falling |= ch_mask; | |
576 | break; | |
577 | default: | |
578 | sr_err("Unknown trigger condition."); | |
579 | return SR_ERR_ARG; | |
580 | } | |
581 | cfg.enabled |= ch_mask; | |
582 | channel = channel->next; | |
583 | } | |
584 | } | |
585 | sr_dbg("Set trigger config: " | |
586 | "channels 0x%04x, trigger-enabled 0x%04x, " | |
587 | "level-triggered 0x%04x, high/falling 0x%04x.", | |
588 | cfg.channels, cfg.enabled, cfg.level, cfg.high_or_falling); | |
589 | ||
590 | devc->trigger_involved = cfg.enabled != 0; | |
591 | ||
592 | wrptr = buf; | |
593 | write_u32le_inc(&wrptr, cfg.channels); | |
594 | write_u32le_inc(&wrptr, cfg.enabled); | |
595 | write_u32le_inc(&wrptr, cfg.level); | |
596 | write_u32le_inc(&wrptr, cfg.high_or_falling); | |
597 | /* TODO | |
598 | * Comment on this literal 16. Origin, meaning? Cannot be the | |
599 | * register offset, nor the transfer length. Is it a channels | |
600 | * count that is relevant for 16 and 32 channel models? Is it | |
601 | * an obsolete experiment? | |
602 | */ | |
603 | ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_TRIGGER, 16, buf, wrptr - buf); | |
604 | if (ret != SR_OK) { | |
605 | sr_err("Cannot setup trigger configuration."); | |
606 | return ret; | |
607 | } | |
608 | ||
609 | return SR_OK; | |
610 | } | |
611 | ||
612 | static int set_sample_config(const struct sr_dev_inst *sdi) | |
613 | { | |
614 | struct dev_context *devc; | |
615 | uint64_t min_samplerate, eff_samplerate; | |
616 | uint16_t divider_u16; | |
617 | uint64_t limit_samples; | |
618 | uint64_t pre_trigger_samples; | |
619 | uint64_t pre_trigger_memory; | |
620 | uint8_t buf[REG_TRIGGER - REG_SAMPLING]; /* Width of REG_SAMPLING. */ | |
621 | uint8_t *wrptr; | |
622 | int ret; | |
623 | ||
624 | devc = sdi->priv; | |
625 | ||
626 | if (devc->samplerate > devc->model->samplerate) { | |
627 | sr_err("Too high a sample rate: %" PRIu64 ".", | |
628 | devc->samplerate); | |
629 | return SR_ERR_ARG; | |
630 | } | |
631 | min_samplerate = devc->model->samplerate; | |
632 | min_samplerate /= 65536; | |
633 | if (devc->samplerate < min_samplerate) { | |
634 | sr_err("Too low a sample rate: %" PRIu64 ".", | |
635 | devc->samplerate); | |
636 | return SR_ERR_ARG; | |
637 | } | |
638 | divider_u16 = devc->model->samplerate / devc->samplerate; | |
639 | eff_samplerate = devc->model->samplerate / divider_u16; | |
640 | ||
641 | ret = sr_sw_limits_get_remain(&devc->sw_limits, | |
642 | &limit_samples, NULL, NULL, NULL); | |
643 | if (ret != SR_OK) { | |
644 | sr_err("Cannot get acquisition limits."); | |
645 | return ret; | |
646 | } | |
647 | if (limit_samples > LA2016_NUM_SAMPLES_MAX) { | |
648 | sr_warn("Too high a sample depth: %" PRIu64 ", capping.", | |
649 | limit_samples); | |
650 | limit_samples = LA2016_NUM_SAMPLES_MAX; | |
651 | } | |
652 | if (limit_samples == 0) { | |
653 | limit_samples = LA2016_NUM_SAMPLES_MAX; | |
654 | sr_dbg("Passing %" PRIu64 " to HW for unlimited samples.", | |
655 | limit_samples); | |
656 | } | |
657 | ||
658 | /* | |
659 | * The acquisition configuration communicates "pre-trigger" | |
660 | * specs in several formats. sigrok users provide a percentage | |
661 | * (0-100%), which translates to a pre-trigger samples count | |
662 | * (assuming that a total samples count limit was specified). | |
663 | * The device supports hardware compression, which depends on | |
664 | * slowly changing input data to be effective. Fast changing | |
665 | * input data may occupy more space in sample memory than its | |
666 | * uncompressed form would. This is why a third parameter can | |
667 | * limit the amount of sample memory to use for pre-trigger | |
668 | * data. Only the upper 24 bits of that memory size spec get | |
669 | * communicated to the device (written to its FPGA register). | |
670 | * | |
671 | * TODO Determine whether the pre-trigger memory size gets | |
672 | * specified in samples or in bytes. A previous implementation | |
673 | * suggests bytes but this is suspicious when every other spec | |
674 | * is in terms of samples. | |
675 | */ | |
676 | if (devc->trigger_involved) { | |
677 | pre_trigger_samples = limit_samples; | |
678 | pre_trigger_samples *= devc->capture_ratio; | |
679 | pre_trigger_samples /= 100; | |
680 | pre_trigger_memory = devc->model->memory_bits; | |
681 | pre_trigger_memory *= UINT64_C(1024 * 1024 * 1024); | |
682 | pre_trigger_memory /= 8; /* devc->model->channel_count ? */ | |
683 | pre_trigger_memory *= devc->capture_ratio; | |
684 | pre_trigger_memory /= 100; | |
685 | } else { | |
686 | sr_dbg("No trigger setup, skipping pre-trigger config."); | |
687 | pre_trigger_samples = 1; | |
688 | pre_trigger_memory = 0; | |
689 | } | |
690 | /* Ensure non-zero value after LSB shift out in HW reg. */ | |
691 | if (pre_trigger_memory < 0x100) { | |
692 | pre_trigger_memory = 0x100; | |
693 | } | |
694 | ||
695 | sr_dbg("Set sample config: %" PRIu64 "kHz, %" PRIu64 " samples.", | |
696 | eff_samplerate / SR_KHZ(1), limit_samples); | |
697 | sr_dbg("Capture ratio %" PRIu64 "%%, count %" PRIu64 ", mem %" PRIu64 ".", | |
698 | devc->capture_ratio, pre_trigger_samples, pre_trigger_memory); | |
699 | ||
700 | /* | |
701 | * The acquisition configuration occupies a total of 16 bytes: | |
702 | * - A 34bit total samples count limit (up to 10 billions) that | |
703 | * is kept in a 40bit register. | |
704 | * - A 34bit pre-trigger samples count limit (up to 10 billions) | |
705 | * in another 40bit register. | |
706 | * - A 32bit pre-trigger memory space limit (in bytes) of which | |
707 | * the upper 24bits are kept in an FPGA register. | |
708 | * - A 16bit clock divider which gets applied to the maximum | |
709 | * samplerate of the device. | |
710 | * - An 8bit register of unknown meaning. Currently always 0. | |
711 | */ | |
712 | wrptr = buf; | |
713 | write_u40le_inc(&wrptr, limit_samples); | |
714 | write_u40le_inc(&wrptr, pre_trigger_samples); | |
715 | write_u24le_inc(&wrptr, pre_trigger_memory >> 8); | |
716 | write_u16le_inc(&wrptr, divider_u16); | |
717 | write_u8_inc(&wrptr, 0); | |
718 | ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_SAMPLING, 0, buf, wrptr - buf); | |
719 | if (ret != SR_OK) { | |
720 | sr_err("Cannot setup acquisition configuration."); | |
721 | return ret; | |
722 | } | |
723 | ||
724 | return SR_OK; | |
725 | } | |
726 | ||
727 | /* | |
728 | * FPGA register REG_RUN holds the run state (u16le format). Bit fields | |
729 | * of interest: | |
730 | * bit 0: value 1 = idle | |
731 | * bit 1: value 1 = writing to SDRAM | |
732 | * bit 2: value 0 = waiting for trigger, 1 = trigger seen | |
733 | * bit 3: value 0 = pretrigger sampling, 1 = posttrigger sampling | |
734 | * The meaning of other bit fields is unknown. | |
735 | * | |
736 | * Typical values in order of appearance during execution: | |
737 | * 0x85e1: idle, no acquisition pending | |
738 | * IDLE set, TRGD don't care, POST don't care; DRAM don't care | |
739 | * "In idle state." Takes precedence over all others. | |
740 | * 0x85e2: pre-sampling, samples before the trigger position, | |
741 | * when capture ratio > 0% | |
742 | * IDLE clear, TRGD clear, POST clear; DRAM don't care | |
743 | * "Not idle any more, no post yet, not triggered yet." | |
744 | * 0x85ea: pre-sampling complete, now waiting for the trigger | |
745 | * (whilst sampling continuously) | |
746 | * IDLE clear, TRGD clear, POST set; DRAM don't care | |
747 | * "Post set thus after pre, not triggered yet" | |
748 | * 0x85ee: trigger seen, capturing post-trigger samples, running | |
749 | * IDLE clear, TRGD set, POST set; DRAM don't care | |
750 | * "Triggered and in post, not idle yet." | |
751 | * 0x85ed: idle | |
752 | * IDLE set, TRGD don't care, POST don't care; DRAM don't care | |
753 | * "In idle state." TRGD/POST don't care, same meaning as above. | |
754 | */ | |
755 | static const uint16_t runstate_mask_idle = RUNSTATE_IDLE_BIT; | |
756 | static const uint16_t runstate_patt_idle = RUNSTATE_IDLE_BIT; | |
757 | static const uint16_t runstate_mask_step = | |
758 | RUNSTATE_IDLE_BIT | RUNSTATE_TRGD_BIT | RUNSTATE_POST_BIT; | |
759 | static const uint16_t runstate_patt_pre_trig = 0; | |
760 | static const uint16_t runstate_patt_wait_trig = RUNSTATE_POST_BIT; | |
761 | static const uint16_t runstate_patt_post_trig = | |
762 | RUNSTATE_TRGD_BIT | RUNSTATE_POST_BIT; | |
763 | ||
764 | static uint16_t run_state(const struct sr_dev_inst *sdi) | |
765 | { | |
766 | static uint16_t previous_state; | |
767 | ||
768 | int ret; | |
769 | uint16_t state; | |
770 | uint8_t buff[REG_PWM_EN - REG_RUN]; /* Width of REG_RUN. */ | |
771 | const uint8_t *rdptr; | |
772 | const char *label; | |
773 | ||
774 | ret = ctrl_in(sdi, CMD_FPGA_SPI, REG_RUN, 0, buff, sizeof(state)); | |
775 | if (ret != SR_OK) { | |
776 | sr_err("Cannot read run state."); | |
777 | return ret; | |
778 | } | |
779 | rdptr = buff; | |
780 | state = read_u16le_inc(&rdptr); | |
781 | ||
782 | /* | |
783 | * Avoid flooding the log, only dump values as they change. | |
784 | * The routine is called about every 50ms. | |
785 | */ | |
786 | if (state == previous_state) | |
787 | return state; | |
788 | ||
789 | previous_state = state; | |
790 | label = NULL; | |
791 | if ((state & runstate_mask_idle) == runstate_patt_idle) | |
792 | label = "idle"; | |
793 | if ((state & runstate_mask_step) == runstate_patt_pre_trig) | |
794 | label = "pre-trigger sampling"; | |
795 | if ((state & runstate_mask_step) == runstate_patt_wait_trig) | |
796 | label = "sampling, waiting for trigger"; | |
797 | if ((state & runstate_mask_step) == runstate_patt_post_trig) | |
798 | label = "post-trigger sampling"; | |
799 | if (label && *label) | |
800 | sr_dbg("Run state: 0x%04x (%s).", state, label); | |
801 | else | |
802 | sr_dbg("Run state: 0x%04x.", state); | |
803 | ||
804 | return state; | |
805 | } | |
806 | ||
807 | static int la2016_is_idle(const struct sr_dev_inst *sdi) | |
808 | { | |
809 | uint16_t state; | |
810 | ||
811 | state = run_state(sdi); | |
812 | if ((state & runstate_mask_idle) == runstate_patt_idle) | |
813 | return 1; | |
814 | ||
815 | return 0; | |
816 | } | |
817 | ||
818 | static int set_run_mode(const struct sr_dev_inst *sdi, uint8_t mode) | |
819 | { | |
820 | int ret; | |
821 | ||
822 | ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_RUN, 0, &mode, sizeof(mode)); | |
823 | if (ret != SR_OK) { | |
824 | sr_err("Cannot configure run mode %d.", mode); | |
825 | return ret; | |
826 | } | |
827 | ||
828 | return SR_OK; | |
829 | } | |
830 | ||
831 | static int get_capture_info(const struct sr_dev_inst *sdi) | |
832 | { | |
833 | struct dev_context *devc; | |
834 | int ret; | |
835 | uint8_t buf[REG_TRIGGER - REG_SAMPLING]; /* Width of REG_SAMPLING. */ | |
836 | const uint8_t *rdptr; | |
837 | ||
838 | devc = sdi->priv; | |
839 | ||
840 | ret = ctrl_in(sdi, CMD_FPGA_SPI, REG_SAMPLING, 0, buf, sizeof(buf)); | |
841 | if (ret != SR_OK) { | |
842 | sr_err("Cannot read capture info."); | |
843 | return ret; | |
844 | } | |
845 | ||
846 | rdptr = buf; | |
847 | devc->info.n_rep_packets = read_u32le_inc(&rdptr); | |
848 | devc->info.n_rep_packets_before_trigger = read_u32le_inc(&rdptr); | |
849 | devc->info.write_pos = read_u32le_inc(&rdptr); | |
850 | ||
851 | sr_dbg("Capture info: n_rep_packets: 0x%08x/%d, before_trigger: 0x%08x/%d, write_pos: 0x%08x/%d.", | |
852 | devc->info.n_rep_packets, devc->info.n_rep_packets, | |
853 | devc->info.n_rep_packets_before_trigger, | |
854 | devc->info.n_rep_packets_before_trigger, | |
855 | devc->info.write_pos, devc->info.write_pos); | |
856 | ||
857 | if (devc->info.n_rep_packets % NUM_PACKETS_IN_CHUNK) { | |
858 | sr_warn("Unexpected packets count %lu, not a multiple of %d.", | |
859 | (unsigned long)devc->info.n_rep_packets, | |
860 | NUM_PACKETS_IN_CHUNK); | |
861 | } | |
862 | ||
863 | return SR_OK; | |
864 | } | |
865 | ||
866 | SR_PRIV int la2016_upload_firmware(const struct sr_dev_inst *sdi, | |
867 | struct sr_context *sr_ctx, libusb_device *dev, uint16_t product_id) | |
868 | { | |
869 | struct dev_context *devc; | |
870 | char *fw_file; | |
871 | int ret; | |
872 | ||
873 | devc = sdi ? sdi->priv : NULL; | |
874 | ||
875 | fw_file = g_strdup_printf(MCU_FWFILE_FMT, product_id); | |
876 | sr_info("USB PID %04hx, MCU firmware '%s'.", product_id, fw_file); | |
877 | ||
878 | ret = ezusb_upload_firmware(sr_ctx, dev, USB_CONFIGURATION, fw_file); | |
879 | if (ret != SR_OK) { | |
880 | g_free(fw_file); | |
881 | return ret; | |
882 | } | |
883 | ||
884 | if (devc) { | |
885 | devc->mcu_firmware = fw_file; | |
886 | fw_file = NULL; | |
887 | } | |
888 | g_free(fw_file); | |
889 | ||
890 | return SR_OK; | |
891 | } | |
892 | ||
893 | SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi, | |
894 | double voltage) | |
895 | { | |
896 | int ret; | |
897 | uint8_t cmd; | |
898 | ||
899 | ret = set_threshold_voltage(sdi, voltage); | |
900 | if (ret != SR_OK) | |
901 | return ret; | |
902 | ||
903 | cmd = 0; | |
904 | ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_CAPT_MODE, 0, &cmd, sizeof(cmd)); | |
905 | if (ret != SR_OK) { | |
906 | sr_err("Cannot send command to stop sampling."); | |
907 | return ret; | |
908 | } | |
909 | ||
910 | ret = set_trigger_config(sdi); | |
911 | if (ret != SR_OK) | |
912 | return ret; | |
913 | ||
914 | ret = set_sample_config(sdi); | |
915 | if (ret != SR_OK) | |
916 | return ret; | |
917 | ||
918 | return SR_OK; | |
919 | } | |
920 | ||
921 | SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi) | |
922 | { | |
923 | int ret; | |
924 | ||
925 | ret = set_run_mode(sdi, RUNMODE_RUN); | |
926 | if (ret != SR_OK) | |
927 | return ret; | |
928 | ||
929 | return SR_OK; | |
930 | } | |
931 | ||
932 | static int la2016_stop_acquisition(const struct sr_dev_inst *sdi) | |
933 | { | |
934 | int ret; | |
935 | ||
936 | ret = set_run_mode(sdi, RUNMODE_HALT); | |
937 | if (ret != SR_OK) | |
938 | return ret; | |
939 | ||
940 | return SR_OK; | |
941 | } | |
942 | ||
943 | SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi) | |
944 | { | |
945 | int ret; | |
946 | struct dev_context *devc; | |
947 | ||
948 | ret = la2016_stop_acquisition(sdi); | |
949 | if (ret != SR_OK) | |
950 | return ret; | |
951 | ||
952 | devc = sdi ? sdi->priv : NULL; | |
953 | if (devc && devc->transfer) | |
954 | libusb_cancel_transfer(devc->transfer); | |
955 | ||
956 | return SR_OK; | |
957 | } | |
958 | ||
959 | static int la2016_start_download(const struct sr_dev_inst *sdi, | |
960 | libusb_transfer_cb_fn cb) | |
961 | { | |
962 | struct dev_context *devc; | |
963 | struct sr_usb_dev_inst *usb; | |
964 | int ret; | |
965 | uint8_t wrbuf[REG_SAMPLING - REG_BULK]; /* Width of REG_BULK. */ | |
966 | uint8_t *wrptr; | |
967 | uint32_t to_read; | |
968 | uint8_t *buffer; | |
969 | ||
970 | devc = sdi->priv; | |
971 | usb = sdi->conn; | |
972 | ||
973 | ret = get_capture_info(sdi); | |
974 | if (ret != SR_OK) | |
975 | return ret; | |
976 | ||
977 | devc->n_transfer_packets_to_read = devc->info.n_rep_packets / NUM_PACKETS_IN_CHUNK; | |
978 | devc->n_bytes_to_read = devc->n_transfer_packets_to_read * TRANSFER_PACKET_LENGTH; | |
979 | devc->read_pos = devc->info.write_pos - devc->n_bytes_to_read; | |
980 | devc->n_reps_until_trigger = devc->info.n_rep_packets_before_trigger; | |
981 | ||
982 | sr_dbg("Want to read %u xfer-packets starting from pos %" PRIu32 ".", | |
983 | devc->n_transfer_packets_to_read, devc->read_pos); | |
984 | ||
985 | ret = ctrl_out(sdi, CMD_BULK_RESET, 0x00, 0, NULL, 0); | |
986 | if (ret != SR_OK) { | |
987 | sr_err("Cannot reset USB bulk state."); | |
988 | return ret; | |
989 | } | |
990 | sr_dbg("Will read from 0x%08lx, 0x%08x bytes.", | |
991 | (unsigned long)devc->read_pos, devc->n_bytes_to_read); | |
992 | wrptr = wrbuf; | |
993 | write_u32le_inc(&wrptr, devc->read_pos); | |
994 | write_u32le_inc(&wrptr, devc->n_bytes_to_read); | |
995 | ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_BULK, 0, wrbuf, wrptr - wrbuf); | |
996 | if (ret != SR_OK) { | |
997 | sr_err("Cannot send USB bulk config."); | |
998 | return ret; | |
999 | } | |
1000 | ret = ctrl_out(sdi, CMD_BULK_START, 0x00, 0, NULL, 0); | |
1001 | if (ret != SR_OK) { | |
1002 | sr_err("Cannot unblock USB bulk transfers."); | |
1003 | return ret; | |
1004 | } | |
1005 | ||
1006 | /* | |
1007 | * Pick a buffer size for all USB transfers. The buffer size | |
1008 | * must be a multiple of the endpoint packet size. And cannot | |
1009 | * exceed a maximum value. | |
1010 | */ | |
1011 | to_read = devc->n_bytes_to_read; | |
1012 | if (to_read >= LA2016_USB_BUFSZ) /* Multiple transfers. */ | |
1013 | to_read = LA2016_USB_BUFSZ; | |
1014 | else /* One transfer. */ | |
1015 | to_read = (to_read + (LA2016_EP6_PKTSZ-1)) & ~(LA2016_EP6_PKTSZ-1); | |
1016 | buffer = g_try_malloc(to_read); | |
1017 | if (!buffer) { | |
1018 | sr_dbg("USB bulk transfer size %d bytes.", (int)to_read); | |
1019 | sr_err("Cannot allocate buffer for USB bulk transfer."); | |
1020 | return SR_ERR_MALLOC; | |
1021 | } | |
1022 | ||
1023 | devc->transfer = libusb_alloc_transfer(0); | |
1024 | libusb_fill_bulk_transfer(devc->transfer, | |
1025 | usb->devhdl, USB_EP_CAPTURE_DATA | LIBUSB_ENDPOINT_IN, | |
1026 | buffer, to_read, cb, (void *)sdi, DEFAULT_TIMEOUT_MS); | |
1027 | ||
1028 | ret = libusb_submit_transfer(devc->transfer); | |
1029 | if (ret != 0) { | |
1030 | sr_err("Cannot submit USB transfer: %s.", libusb_error_name(ret)); | |
1031 | libusb_free_transfer(devc->transfer); | |
1032 | devc->transfer = NULL; | |
1033 | g_free(buffer); | |
1034 | return SR_ERR_IO; | |
1035 | } | |
1036 | ||
1037 | return SR_OK; | |
1038 | } | |
1039 | ||
1040 | /* | |
1041 | * A chunk (received via USB) contains a number of transfers (USB length | |
1042 | * divided by 16) which contain a number of packets (5 per transfer) which | |
1043 | * contain a number of samples (8bit repeat count per 16bit sample data). | |
1044 | */ | |
1045 | static void send_chunk(struct sr_dev_inst *sdi, | |
1046 | const uint8_t *packets, size_t num_xfers) | |
1047 | { | |
1048 | struct dev_context *devc; | |
1049 | size_t num_pkts; | |
1050 | const uint8_t *rp; | |
1051 | uint16_t sample_value; | |
1052 | size_t repetitions; | |
1053 | uint8_t sample_buff[sizeof(sample_value)]; | |
1054 | ||
1055 | devc = sdi->priv; | |
1056 | ||
1057 | /* Ignore incoming USB data after complete sample data download. */ | |
1058 | if (devc->download_finished) | |
1059 | return; | |
1060 | ||
1061 | if (devc->trigger_involved && !devc->trigger_marked && devc->info.n_rep_packets_before_trigger == 0) { | |
1062 | feed_queue_logic_send_trigger(devc->feed_queue); | |
1063 | devc->trigger_marked = TRUE; | |
1064 | } | |
1065 | ||
1066 | rp = packets; | |
1067 | while (num_xfers--) { | |
1068 | num_pkts = NUM_PACKETS_IN_CHUNK; | |
1069 | while (num_pkts--) { | |
1070 | ||
1071 | sample_value = read_u16le_inc(&rp); | |
1072 | repetitions = read_u8_inc(&rp); | |
1073 | ||
1074 | devc->total_samples += repetitions; | |
1075 | ||
1076 | write_u16le(sample_buff, sample_value); | |
1077 | feed_queue_logic_submit(devc->feed_queue, | |
1078 | sample_buff, repetitions); | |
1079 | sr_sw_limits_update_samples_read(&devc->sw_limits, | |
1080 | repetitions); | |
1081 | ||
1082 | if (devc->trigger_involved && !devc->trigger_marked) { | |
1083 | if (!--devc->n_reps_until_trigger) { | |
1084 | feed_queue_logic_send_trigger(devc->feed_queue); | |
1085 | devc->trigger_marked = TRUE; | |
1086 | sr_dbg("Trigger position after %" PRIu64 " samples, %.6fms.", | |
1087 | devc->total_samples, | |
1088 | (double)devc->total_samples / devc->samplerate * 1e3); | |
1089 | } | |
1090 | } | |
1091 | } | |
1092 | (void)read_u8_inc(&rp); /* Skip sequence number. */ | |
1093 | } | |
1094 | ||
1095 | if (!devc->download_finished && sr_sw_limits_check(&devc->sw_limits)) { | |
1096 | sr_dbg("Acquisition limit reached."); | |
1097 | devc->download_finished = TRUE; | |
1098 | } | |
1099 | if (devc->download_finished) { | |
1100 | sr_dbg("Download finished, flushing session feed queue."); | |
1101 | feed_queue_logic_flush(devc->feed_queue); | |
1102 | } | |
1103 | sr_dbg("Total samples after chunk: %" PRIu64 ".", devc->total_samples); | |
1104 | } | |
1105 | ||
1106 | static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer) | |
1107 | { | |
1108 | struct sr_dev_inst *sdi; | |
1109 | struct dev_context *devc; | |
1110 | struct sr_usb_dev_inst *usb; | |
1111 | size_t num_xfers; | |
1112 | int ret; | |
1113 | ||
1114 | sdi = transfer->user_data; | |
1115 | devc = sdi->priv; | |
1116 | usb = sdi->conn; | |
1117 | ||
1118 | sr_dbg("receive_transfer(): status %s received %d bytes.", | |
1119 | libusb_error_name(transfer->status), transfer->actual_length); | |
1120 | /* | |
1121 | * Implementation detail: A USB transfer timeout is not fatal | |
1122 | * here. We just process whatever was received, empty input is | |
1123 | * perfectly acceptable. Reaching (or exceeding) the sw limits | |
1124 | * or exhausting the device's captured data will complete the | |
1125 | * sample data download. | |
1126 | */ | |
1127 | num_xfers = transfer->actual_length / TRANSFER_PACKET_LENGTH; | |
1128 | send_chunk(sdi, transfer->buffer, num_xfers); | |
1129 | ||
1130 | devc->n_bytes_to_read -= transfer->actual_length; | |
1131 | if (devc->n_bytes_to_read) { | |
1132 | uint32_t to_read = devc->n_bytes_to_read; | |
1133 | /* | |
1134 | * Determine read size for the next USB transfer. Make | |
1135 | * the buffer size a multiple of the endpoint packet | |
1136 | * size. Don't exceed a maximum value. | |
1137 | */ | |
1138 | if (to_read >= LA2016_USB_BUFSZ) | |
1139 | to_read = LA2016_USB_BUFSZ; | |
1140 | else | |
1141 | to_read = (to_read + (LA2016_EP6_PKTSZ-1)) & ~(LA2016_EP6_PKTSZ-1); | |
1142 | libusb_fill_bulk_transfer(transfer, | |
1143 | usb->devhdl, USB_EP_CAPTURE_DATA | LIBUSB_ENDPOINT_IN, | |
1144 | transfer->buffer, to_read, | |
1145 | receive_transfer, (void *)sdi, DEFAULT_TIMEOUT_MS); | |
1146 | ||
1147 | ret = libusb_submit_transfer(transfer); | |
1148 | if (ret == 0) | |
1149 | return; | |
1150 | sr_err("Cannot submit another USB transfer: %s.", | |
1151 | libusb_error_name(ret)); | |
1152 | } | |
1153 | ||
1154 | g_free(transfer->buffer); | |
1155 | libusb_free_transfer(transfer); | |
1156 | devc->download_finished = TRUE; | |
1157 | } | |
1158 | ||
1159 | SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data) | |
1160 | { | |
1161 | const struct sr_dev_inst *sdi; | |
1162 | struct dev_context *devc; | |
1163 | struct drv_context *drvc; | |
1164 | struct timeval tv; | |
1165 | int ret; | |
1166 | ||
1167 | (void)fd; | |
1168 | (void)revents; | |
1169 | ||
1170 | sdi = cb_data; | |
1171 | devc = sdi->priv; | |
1172 | drvc = sdi->driver->context; | |
1173 | ||
1174 | /* | |
1175 | * Wait for the acquisition to complete in hardware. | |
1176 | * Periodically check a potentially configured msecs timeout. | |
1177 | */ | |
1178 | if (!devc->completion_seen) { | |
1179 | if (!la2016_is_idle(sdi)) { | |
1180 | if (sr_sw_limits_check(&devc->sw_limits)) { | |
1181 | devc->sw_limits.limit_msec = 0; | |
1182 | sr_dbg("Limit reached. Stopping acquisition."); | |
1183 | la2016_stop_acquisition(sdi); | |
1184 | } | |
1185 | /* Not yet ready for sample data download. */ | |
1186 | return TRUE; | |
1187 | } | |
1188 | sr_dbg("Acquisition completion seen (hardware)."); | |
1189 | devc->sw_limits.limit_msec = 0; | |
1190 | devc->completion_seen = TRUE; | |
1191 | devc->download_finished = FALSE; | |
1192 | devc->trigger_marked = FALSE; | |
1193 | devc->total_samples = 0; | |
1194 | ||
1195 | /* Initiate the download of acquired sample data. */ | |
1196 | std_session_send_df_frame_begin(sdi); | |
1197 | ret = la2016_start_download(sdi, receive_transfer); | |
1198 | if (ret != SR_OK) { | |
1199 | sr_err("Cannot start acquisition data download."); | |
1200 | return FALSE; | |
1201 | } | |
1202 | sr_dbg("Acquisition data download started."); | |
1203 | ||
1204 | return TRUE; | |
1205 | } | |
1206 | ||
1207 | /* Handle USB reception. Drives sample data download. */ | |
1208 | tv.tv_sec = tv.tv_usec = 0; | |
1209 | libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv); | |
1210 | ||
1211 | /* Postprocess completion of sample data download. */ | |
1212 | if (devc->download_finished) { | |
1213 | sr_dbg("Download finished, post processing."); | |
1214 | ||
1215 | la2016_stop_acquisition(sdi); | |
1216 | usb_source_remove(sdi->session, drvc->sr_ctx); | |
1217 | devc->transfer = NULL; | |
1218 | ||
1219 | feed_queue_logic_flush(devc->feed_queue); | |
1220 | feed_queue_logic_free(devc->feed_queue); | |
1221 | devc->feed_queue = NULL; | |
1222 | std_session_send_df_frame_end(sdi); | |
1223 | std_session_send_df_end(sdi); | |
1224 | ||
1225 | sr_dbg("Download finished, done post processing."); | |
1226 | } | |
1227 | ||
1228 | return TRUE; | |
1229 | } | |
1230 | ||
1231 | SR_PRIV int la2016_identify_device(const struct sr_dev_inst *sdi, | |
1232 | gboolean show_message) | |
1233 | { | |
1234 | struct dev_context *devc; | |
1235 | uint8_t buf[8]; /* Larger size of manuf date and device type magic. */ | |
1236 | size_t rdoff, rdlen; | |
1237 | const uint8_t *rdptr; | |
1238 | uint8_t date_yy, date_mm; | |
1239 | uint8_t dinv_yy, dinv_mm; | |
1240 | uint8_t magic; | |
1241 | size_t model_idx; | |
1242 | const struct kingst_model *model; | |
1243 | int ret; | |
1244 | ||
1245 | devc = sdi->priv; | |
1246 | ||
1247 | /* | |
1248 | * Four EEPROM bytes at offset 0x20 are the manufacturing date, | |
1249 | * year and month in BCD format, followed by inverted values for | |
1250 | * consistency checks. For example bytes 20 04 df fb translate | |
1251 | * to 2020-04. This information can help identify the vintage of | |
1252 | * devices when unknown magic numbers are seen. | |
1253 | */ | |
1254 | rdoff = 0x20; | |
1255 | rdlen = 4 * sizeof(uint8_t); | |
1256 | ret = ctrl_in(sdi, CMD_EEPROM, rdoff, 0, buf, rdlen); | |
1257 | if (ret != SR_OK && !show_message) { | |
1258 | /* Non-fatal weak attempt during probe. Not worth logging. */ | |
1259 | sr_dbg("Cannot access EEPROM."); | |
1260 | return SR_ERR_IO; | |
1261 | } else if (ret != SR_OK) { | |
1262 | /* Failed attempt in regular use. Non-fatal. Worth logging. */ | |
1263 | sr_err("Cannot read manufacture date in EEPROM."); | |
1264 | } else { | |
1265 | if (sr_log_loglevel_get() >= SR_LOG_SPEW) { | |
1266 | GString *txt; | |
1267 | txt = sr_hexdump_new(buf, rdlen); | |
1268 | sr_spew("Manufacture date bytes %s.", txt->str); | |
1269 | sr_hexdump_free(txt); | |
1270 | } | |
1271 | rdptr = &buf[0]; | |
1272 | date_yy = read_u8_inc(&rdptr); | |
1273 | date_mm = read_u8_inc(&rdptr); | |
1274 | dinv_yy = read_u8_inc(&rdptr); | |
1275 | dinv_mm = read_u8_inc(&rdptr); | |
1276 | sr_info("Manufacture date: 20%02hx-%02hx.", date_yy, date_mm); | |
1277 | if ((date_mm ^ dinv_mm) != 0xff || (date_yy ^ dinv_yy) != 0xff) | |
1278 | sr_warn("Manufacture date fails checksum test."); | |
1279 | } | |
1280 | ||
1281 | /* | |
1282 | * Several Kingst logic analyzer devices share the same USB VID | |
1283 | * and PID. The product ID determines which MCU firmware to load. | |
1284 | * The MCU firmware provides access to EEPROM content which then | |
1285 | * allows to identify the device model. Which in turn determines | |
1286 | * which FPGA bitstream to load. Eight bytes at offset 0x08 are | |
1287 | * to get inspected. | |
1288 | * | |
1289 | * EEPROM content for model identification is kept redundantly | |
1290 | * in memory. The values are stored in verbatim and in inverted | |
1291 | * form, multiple copies are kept at different offsets. Example | |
1292 | * data: | |
1293 | * | |
1294 | * magic 0x08 | |
1295 | * | ~magic 0xf7 | |
1296 | * | | | |
1297 | * 08f7000008f710ef | |
1298 | * | | | |
1299 | * | ~magic backup | |
1300 | * magic backup | |
1301 | * | |
1302 | * Exclusively inspecting the magic byte appears to be sufficient, | |
1303 | * other fields seem to be 'don't care'. | |
1304 | * | |
1305 | * magic 2 == LA2016 using "kingst-la2016-fpga.bitstream" | |
1306 | * magic 3 == LA1016 using "kingst-la1016-fpga.bitstream" | |
1307 | * magic 8 == LA2016a using "kingst-la2016a1-fpga.bitstream" | |
1308 | * (latest v1.3.0 PCB, perhaps others) | |
1309 | * magic 9 == LA1016a using "kingst-la1016a1-fpga.bitstream" | |
1310 | * (latest v1.3.0 PCB, perhaps others) | |
1311 | * | |
1312 | * When EEPROM content does not match the hardware configuration | |
1313 | * (the board layout), the software may load but yield incorrect | |
1314 | * results (like swapped channels). The FPGA bitstream itself | |
1315 | * will authenticate with IC U10 and fail when its capabilities | |
1316 | * do not match the hardware model. An LA1016 won't become a | |
1317 | * LA2016 by faking its EEPROM content. | |
1318 | */ | |
1319 | devc->identify_magic = 0; | |
1320 | rdoff = 0x08; | |
1321 | rdlen = 8 * sizeof(uint8_t); | |
1322 | ret = ctrl_in(sdi, CMD_EEPROM, rdoff, 0, &buf, rdlen); | |
1323 | if (ret != SR_OK) { | |
1324 | sr_err("Cannot read EEPROM device identifier bytes."); | |
1325 | return ret; | |
1326 | } | |
1327 | if (sr_log_loglevel_get() >= SR_LOG_SPEW) { | |
1328 | GString *txt; | |
1329 | txt = sr_hexdump_new(buf, rdlen); | |
1330 | sr_spew("EEPROM magic bytes %s.", txt->str); | |
1331 | sr_hexdump_free(txt); | |
1332 | } | |
1333 | if ((buf[0] ^ buf[1]) == 0xff) { | |
1334 | /* Primary copy of magic passes complement check. */ | |
1335 | magic = buf[0]; | |
1336 | sr_dbg("Using primary magic, value %d.", (int)magic); | |
1337 | } else if ((buf[4] ^ buf[5]) == 0xff) { | |
1338 | /* Backup copy of magic passes complement check. */ | |
1339 | magic = buf[4]; | |
1340 | sr_dbg("Using backup magic, value %d.", (int)magic); | |
1341 | } else { | |
1342 | sr_err("Cannot find consistent device type identification."); | |
1343 | magic = 0; | |
1344 | } | |
1345 | devc->identify_magic = magic; | |
1346 | ||
1347 | devc->model = NULL; | |
1348 | for (model_idx = 0; model_idx < ARRAY_SIZE(models); model_idx++) { | |
1349 | model = &models[model_idx]; | |
1350 | if (model->magic != magic) | |
1351 | continue; | |
1352 | devc->model = model; | |
1353 | sr_info("Model '%s', %zu channels, max %" PRIu64 "MHz.", | |
1354 | model->name, model->channel_count, | |
1355 | model->samplerate / SR_MHZ(1)); | |
1356 | devc->fpga_bitstream = g_strdup_printf(FPGA_FWFILE_FMT, | |
1357 | model->fpga_stem); | |
1358 | sr_info("FPGA bitstream file '%s'.", devc->fpga_bitstream); | |
1359 | break; | |
1360 | } | |
1361 | if (!devc->model) { | |
1362 | sr_err("Cannot identify as one of the supported models."); | |
1363 | return SR_ERR_DATA; | |
1364 | } | |
1365 | ||
1366 | return SR_OK; | |
1367 | } | |
1368 | ||
1369 | SR_PRIV int la2016_init_hardware(const struct sr_dev_inst *sdi) | |
1370 | { | |
1371 | struct dev_context *devc; | |
1372 | const char *bitstream_fn; | |
1373 | int ret; | |
1374 | uint16_t state; | |
1375 | ||
1376 | devc = sdi->priv; | |
1377 | bitstream_fn = devc ? devc->fpga_bitstream : ""; | |
1378 | ||
1379 | ret = check_fpga_bitstream(sdi); | |
1380 | if (ret != SR_OK) { | |
1381 | ret = upload_fpga_bitstream(sdi, bitstream_fn); | |
1382 | if (ret != SR_OK) { | |
1383 | sr_err("Cannot upload FPGA bitstream."); | |
1384 | return ret; | |
1385 | } | |
1386 | } | |
1387 | ret = enable_fpga_bitstream(sdi); | |
1388 | if (ret != SR_OK) { | |
1389 | sr_err("Cannot enable FPGA bitstream after upload."); | |
1390 | return ret; | |
1391 | } | |
1392 | ||
1393 | state = run_state(sdi); | |
1394 | if (state != 0x85e9) { | |
1395 | sr_warn("Unexpected run state, want 0x85e9, got 0x%04x.", state); | |
1396 | } | |
1397 | ||
1398 | ret = ctrl_out(sdi, CMD_BULK_RESET, 0x00, 0, NULL, 0); | |
1399 | if (ret != SR_OK) { | |
1400 | sr_err("Cannot reset USB bulk transfer."); | |
1401 | return ret; | |
1402 | } | |
1403 | ||
1404 | sr_dbg("Device should be initialized."); | |
1405 | ||
1406 | return SR_OK; | |
1407 | } | |
1408 | ||
1409 | SR_PRIV int la2016_deinit_hardware(const struct sr_dev_inst *sdi) | |
1410 | { | |
1411 | int ret; | |
1412 | ||
1413 | ret = ctrl_out(sdi, CMD_FPGA_ENABLE, 0x00, 0, NULL, 0); | |
1414 | if (ret != SR_OK) { | |
1415 | sr_err("Cannot deinitialize device's FPGA."); | |
1416 | return ret; | |
1417 | } | |
1418 | ||
1419 | return SR_OK; | |
1420 | } | |
1421 | ||
1422 | SR_PRIV int la2016_write_pwm_config(const struct sr_dev_inst *sdi, size_t idx) | |
1423 | { | |
1424 | return set_pwm_config(sdi, idx); | |
1425 | } |