]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> | |
5 | * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk> | |
6 | * | |
7 | * This program is free software: you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation, either version 3 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 | */ | |
20 | ||
21 | #include <stdio.h> | |
22 | #include <stdlib.h> | |
23 | #include <string.h> | |
24 | #include <inttypes.h> | |
25 | #include <libusb.h> | |
26 | #include "libsigrok.h" | |
27 | #include "libsigrok-internal.h" | |
28 | #include "fx2lafw.h" | |
29 | #include "command.h" | |
30 | ||
31 | static const struct fx2lafw_profile supported_fx2[] = { | |
32 | /* | |
33 | * CWAV USBee AX | |
34 | * EE Electronics ESLA201A | |
35 | * ARMFLY AX-Pro | |
36 | */ | |
37 | { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL, | |
38 | FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw", | |
39 | 0 }, | |
40 | /* | |
41 | * CWAV USBee DX | |
42 | * XZL-Studio DX | |
43 | */ | |
44 | { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL, | |
45 | FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw", | |
46 | DEV_CAPS_16BIT }, | |
47 | ||
48 | /* | |
49 | * CWAV USBee SX | |
50 | */ | |
51 | { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL, | |
52 | FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw", | |
53 | 0 }, | |
54 | ||
55 | /* | |
56 | * Saleae Logic | |
57 | * EE Electronics ESLA100 | |
58 | * Robomotic MiniLogic | |
59 | * Robomotic BugLogic 3 | |
60 | */ | |
61 | { 0x0925, 0x3881, "Saleae", "Logic", NULL, | |
62 | FIRMWARE_DIR "/fx2lafw-saleae-logic.fw", | |
63 | 0 }, | |
64 | ||
65 | /* | |
66 | * Default Cypress FX2 without EEPROM, e.g.: | |
67 | * Lcsoft Mini Board | |
68 | * Braintechnology USB Interface V2.x | |
69 | */ | |
70 | { 0x04B4, 0x8613, "Cypress", "FX2", NULL, | |
71 | FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw", | |
72 | DEV_CAPS_16BIT }, | |
73 | ||
74 | /* | |
75 | * Braintechnology USB-LPS | |
76 | */ | |
77 | { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL, | |
78 | FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw", | |
79 | DEV_CAPS_16BIT }, | |
80 | ||
81 | { 0, 0, 0, 0, 0, 0, 0 } | |
82 | }; | |
83 | ||
84 | static const int hwcaps[] = { | |
85 | SR_HWCAP_LOGIC_ANALYZER, | |
86 | SR_HWCAP_SAMPLERATE, | |
87 | ||
88 | /* These are really implemented in the driver, not the hardware. */ | |
89 | SR_HWCAP_LIMIT_SAMPLES, | |
90 | SR_HWCAP_CONTINUOUS, | |
91 | 0, | |
92 | }; | |
93 | ||
94 | static const char *probe_names[] = { | |
95 | "0", | |
96 | "1", | |
97 | "2", | |
98 | "3", | |
99 | "4", | |
100 | "5", | |
101 | "6", | |
102 | "7", | |
103 | "8", | |
104 | "9", | |
105 | "10", | |
106 | "11", | |
107 | "12", | |
108 | "13", | |
109 | "14", | |
110 | "15", | |
111 | NULL, | |
112 | }; | |
113 | ||
114 | static const uint64_t supported_samplerates[] = { | |
115 | SR_KHZ(20), | |
116 | SR_KHZ(25), | |
117 | SR_KHZ(50), | |
118 | SR_KHZ(100), | |
119 | SR_KHZ(200), | |
120 | SR_KHZ(250), | |
121 | SR_KHZ(500), | |
122 | SR_MHZ(1), | |
123 | SR_MHZ(2), | |
124 | SR_MHZ(3), | |
125 | SR_MHZ(4), | |
126 | SR_MHZ(6), | |
127 | SR_MHZ(8), | |
128 | SR_MHZ(12), | |
129 | SR_MHZ(16), | |
130 | SR_MHZ(24), | |
131 | 0, | |
132 | }; | |
133 | ||
134 | static const struct sr_samplerates samplerates = { | |
135 | 0, | |
136 | 0, | |
137 | 0, | |
138 | supported_samplerates, | |
139 | }; | |
140 | ||
141 | SR_PRIV struct sr_dev_driver fx2lafw_driver_info; | |
142 | static struct sr_dev_driver *fdi = &fx2lafw_driver_info; | |
143 | static int hw_dev_close(struct sr_dev_inst *sdi); | |
144 | static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, | |
145 | const void *value); | |
146 | static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data); | |
147 | ||
148 | /** | |
149 | * Check the USB configuration to determine if this is an fx2lafw device. | |
150 | * | |
151 | * @return TRUE if the device's configuration profile match fx2lafw | |
152 | * configuration, FALSE otherwise. | |
153 | */ | |
154 | static gboolean check_conf_profile(libusb_device *dev) | |
155 | { | |
156 | struct libusb_device_descriptor des; | |
157 | struct libusb_device_handle *hdl; | |
158 | gboolean ret; | |
159 | unsigned char strdesc[64]; | |
160 | ||
161 | hdl = NULL; | |
162 | ret = FALSE; | |
163 | while (!ret) { | |
164 | /* Assume the FW has not been loaded, unless proven wrong. */ | |
165 | if (libusb_get_device_descriptor(dev, &des) != 0) | |
166 | break; | |
167 | ||
168 | if (libusb_open(dev, &hdl) != 0) | |
169 | break; | |
170 | ||
171 | if (libusb_get_string_descriptor_ascii(hdl, | |
172 | des.iManufacturer, strdesc, sizeof(strdesc)) < 0) | |
173 | break; | |
174 | if (strncmp((const char *)strdesc, "sigrok", 6)) | |
175 | break; | |
176 | ||
177 | if (libusb_get_string_descriptor_ascii(hdl, | |
178 | des.iProduct, strdesc, sizeof(strdesc)) < 0) | |
179 | break; | |
180 | if (strncmp((const char *)strdesc, "fx2lafw", 7)) | |
181 | break; | |
182 | ||
183 | /* If we made it here, it must be an fx2lafw. */ | |
184 | ret = TRUE; | |
185 | } | |
186 | if (hdl) | |
187 | libusb_close(hdl); | |
188 | ||
189 | return ret; | |
190 | } | |
191 | ||
192 | static int fx2lafw_dev_open(struct sr_dev_inst *sdi) | |
193 | { | |
194 | libusb_device **devlist; | |
195 | struct libusb_device_descriptor des; | |
196 | struct dev_context *devc; | |
197 | struct drv_context *drvc = fdi->priv; | |
198 | struct version_info vi; | |
199 | int ret, skip, i; | |
200 | uint8_t revid; | |
201 | ||
202 | devc = sdi->priv; | |
203 | ||
204 | if (sdi->status == SR_ST_ACTIVE) | |
205 | /* already in use */ | |
206 | return SR_ERR; | |
207 | ||
208 | skip = 0; | |
209 | const int device_count = libusb_get_device_list( | |
210 | drvc->sr_ctx->libusb_ctx, &devlist); | |
211 | if (device_count < 0) { | |
212 | sr_err("fx2lafw: Failed to retrieve device list (%d)", | |
213 | device_count); | |
214 | return SR_ERR; | |
215 | } | |
216 | ||
217 | for (i = 0; i < device_count; i++) { | |
218 | if ((ret = libusb_get_device_descriptor(devlist[i], &des))) { | |
219 | sr_err("fx2lafw: Failed to get device descriptor: %s.", | |
220 | libusb_error_name(ret)); | |
221 | continue; | |
222 | } | |
223 | ||
224 | if (des.idVendor != devc->profile->vid | |
225 | || des.idProduct != devc->profile->pid) | |
226 | continue; | |
227 | ||
228 | if (sdi->status == SR_ST_INITIALIZING) { | |
229 | if (skip != sdi->index) { | |
230 | /* Skip devices of this type that aren't the one we want. */ | |
231 | skip += 1; | |
232 | continue; | |
233 | } | |
234 | } else if (sdi->status == SR_ST_INACTIVE) { | |
235 | /* | |
236 | * This device is fully enumerated, so we need to find | |
237 | * this device by vendor, product, bus and address. | |
238 | */ | |
239 | if (libusb_get_bus_number(devlist[i]) != devc->usb->bus | |
240 | || libusb_get_device_address(devlist[i]) != devc->usb->address) | |
241 | /* this is not the one */ | |
242 | continue; | |
243 | } | |
244 | ||
245 | if (!(ret = libusb_open(devlist[i], &devc->usb->devhdl))) { | |
246 | if (devc->usb->address == 0xff) | |
247 | /* | |
248 | * first time we touch this device after firmware upload, | |
249 | * so we don't know the address yet. | |
250 | */ | |
251 | devc->usb->address = libusb_get_device_address(devlist[i]); | |
252 | } else { | |
253 | sr_err("fx2lafw: Failed to open device: %s.", | |
254 | libusb_error_name(ret)); | |
255 | break; | |
256 | } | |
257 | ||
258 | ret = command_get_fw_version(devc->usb->devhdl, &vi); | |
259 | if (ret != SR_OK) { | |
260 | sr_err("fx2lafw: Failed to retrieve " | |
261 | "firmware version information."); | |
262 | break; | |
263 | } | |
264 | ||
265 | ret = command_get_revid_version(devc->usb->devhdl, &revid); | |
266 | if (ret != SR_OK) { | |
267 | sr_err("fx2lafw: Failed to retrieve REVID."); | |
268 | break; | |
269 | } | |
270 | ||
271 | /* | |
272 | * Changes in major version mean incompatible/API changes, so | |
273 | * bail out if we encounter an incompatible version. | |
274 | * Different minor versions are OK, they should be compatible. | |
275 | */ | |
276 | if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) { | |
277 | sr_err("fx2lafw: Expected firmware version %d.x, " | |
278 | "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR, | |
279 | vi.major, vi.minor); | |
280 | break; | |
281 | } | |
282 | ||
283 | sdi->status = SR_ST_ACTIVE; | |
284 | sr_info("fx2lafw: Opened device %d on %d.%d " | |
285 | "interface %d, firmware %d.%d, REVID %d.", | |
286 | sdi->index, devc->usb->bus, devc->usb->address, | |
287 | USB_INTERFACE, vi.major, vi.minor, revid); | |
288 | ||
289 | break; | |
290 | } | |
291 | libusb_free_device_list(devlist, 1); | |
292 | ||
293 | if (sdi->status != SR_ST_ACTIVE) | |
294 | return SR_ERR; | |
295 | ||
296 | return SR_OK; | |
297 | } | |
298 | ||
299 | static int configure_probes(const struct sr_dev_inst *sdi) | |
300 | { | |
301 | struct dev_context *devc; | |
302 | struct sr_probe *probe; | |
303 | GSList *l; | |
304 | int probe_bit, stage, i; | |
305 | char *tc; | |
306 | ||
307 | devc = sdi->priv; | |
308 | for (i = 0; i < NUM_TRIGGER_STAGES; i++) { | |
309 | devc->trigger_mask[i] = 0; | |
310 | devc->trigger_value[i] = 0; | |
311 | } | |
312 | ||
313 | stage = -1; | |
314 | for (l = sdi->probes; l; l = l->next) { | |
315 | probe = (struct sr_probe *)l->data; | |
316 | if (probe->enabled == FALSE) | |
317 | continue; | |
318 | ||
319 | if (probe->index > 7) | |
320 | devc->sample_wide = TRUE; | |
321 | ||
322 | probe_bit = 1 << (probe->index); | |
323 | if (!(probe->trigger)) | |
324 | continue; | |
325 | ||
326 | stage = 0; | |
327 | for (tc = probe->trigger; *tc; tc++) { | |
328 | devc->trigger_mask[stage] |= probe_bit; | |
329 | if (*tc == '1') | |
330 | devc->trigger_value[stage] |= probe_bit; | |
331 | stage++; | |
332 | if (stage > NUM_TRIGGER_STAGES) | |
333 | return SR_ERR; | |
334 | } | |
335 | } | |
336 | ||
337 | if (stage == -1) | |
338 | /* | |
339 | * We didn't configure any triggers, make sure acquisition | |
340 | * doesn't wait for any. | |
341 | */ | |
342 | devc->trigger_stage = TRIGGER_FIRED; | |
343 | else | |
344 | devc->trigger_stage = 0; | |
345 | ||
346 | return SR_OK; | |
347 | } | |
348 | ||
349 | static struct dev_context *fx2lafw_dev_new(void) | |
350 | { | |
351 | struct dev_context *devc; | |
352 | ||
353 | if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) { | |
354 | sr_err("fx2lafw: %s: devc malloc failed.", __func__); | |
355 | return NULL; | |
356 | } | |
357 | ||
358 | devc->trigger_stage = TRIGGER_FIRED; | |
359 | ||
360 | return devc; | |
361 | } | |
362 | ||
363 | static int clear_instances(void) | |
364 | { | |
365 | GSList *l; | |
366 | struct sr_dev_inst *sdi; | |
367 | struct drv_context *drvc; | |
368 | struct dev_context *devc; | |
369 | int ret; | |
370 | ||
371 | drvc = fdi->priv; | |
372 | ret = SR_OK; | |
373 | for (l = drvc->instances; l; l = l->next) { | |
374 | if (!(sdi = l->data)) { | |
375 | /* Log error, but continue cleaning up the rest. */ | |
376 | sr_err("fx2lafw: %s: sdi was NULL, continuing.", | |
377 | __func__); | |
378 | ret = SR_ERR_BUG; | |
379 | continue; | |
380 | } | |
381 | if (!(devc = sdi->priv)) { | |
382 | /* Log error, but continue cleaning up the rest. */ | |
383 | sr_err("fx2lafw: %s: sdi->priv was NULL, continuing", | |
384 | __func__); | |
385 | ret = SR_ERR_BUG; | |
386 | continue; | |
387 | } | |
388 | hw_dev_close(sdi); | |
389 | sr_usb_dev_inst_free(devc->usb); | |
390 | sdi = l->data; | |
391 | sr_dev_inst_free(sdi); | |
392 | } | |
393 | ||
394 | g_slist_free(drvc->instances); | |
395 | drvc->instances = NULL; | |
396 | ||
397 | return ret; | |
398 | } | |
399 | ||
400 | ||
401 | /* | |
402 | * API callbacks | |
403 | */ | |
404 | ||
405 | static int hw_init(struct sr_context *sr_ctx) | |
406 | { | |
407 | struct drv_context *drvc; | |
408 | ||
409 | if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) { | |
410 | sr_err("fx2lafw: driver context malloc failed."); | |
411 | return SR_ERR_MALLOC; | |
412 | } | |
413 | ||
414 | drvc->sr_ctx = sr_ctx; | |
415 | fdi->priv = drvc; | |
416 | ||
417 | return SR_OK; | |
418 | } | |
419 | ||
420 | static GSList *hw_scan(GSList *options) | |
421 | { | |
422 | GSList *devices; | |
423 | struct libusb_device_descriptor des; | |
424 | struct sr_dev_inst *sdi; | |
425 | const struct fx2lafw_profile *prof; | |
426 | struct drv_context *drvc; | |
427 | struct dev_context *devc; | |
428 | struct sr_probe *probe; | |
429 | libusb_device **devlist; | |
430 | int devcnt, num_logic_probes, ret, i, j; | |
431 | ||
432 | (void)options; | |
433 | ||
434 | drvc = fdi->priv; | |
435 | ||
436 | /* This scan always invalidates any previous scans. */ | |
437 | clear_instances(); | |
438 | ||
439 | /* Find all fx2lafw compatible devices and upload firmware to them. */ | |
440 | devices = NULL; | |
441 | libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); | |
442 | for (i = 0; devlist[i]; i++) { | |
443 | ||
444 | if ((ret = libusb_get_device_descriptor( | |
445 | devlist[i], &des)) != 0) { | |
446 | sr_warn("fx2lafw: Failed to get device descriptor: %s.", | |
447 | libusb_error_name(ret)); | |
448 | continue; | |
449 | } | |
450 | ||
451 | prof = NULL; | |
452 | for (j = 0; supported_fx2[j].vid; j++) { | |
453 | if (des.idVendor == supported_fx2[j].vid && | |
454 | des.idProduct == supported_fx2[j].pid) { | |
455 | prof = &supported_fx2[j]; | |
456 | } | |
457 | } | |
458 | ||
459 | /* Skip if the device was not found */ | |
460 | if (!prof) | |
461 | continue; | |
462 | ||
463 | devcnt = g_slist_length(drvc->instances); | |
464 | sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING, | |
465 | prof->vendor, prof->model, prof->model_version); | |
466 | if (!sdi) | |
467 | return NULL; | |
468 | sdi->driver = fdi; | |
469 | ||
470 | /* Fill in probelist according to this device's profile. */ | |
471 | num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8; | |
472 | for (j = 0; j < num_logic_probes; j++) { | |
473 | if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE, | |
474 | probe_names[j]))) | |
475 | return NULL; | |
476 | sdi->probes = g_slist_append(sdi->probes, probe); | |
477 | } | |
478 | ||
479 | devc = fx2lafw_dev_new(); | |
480 | devc->profile = prof; | |
481 | sdi->priv = devc; | |
482 | drvc->instances = g_slist_append(drvc->instances, sdi); | |
483 | devices = g_slist_append(devices, sdi); | |
484 | ||
485 | if (check_conf_profile(devlist[i])) { | |
486 | /* Already has the firmware, so fix the new address. */ | |
487 | sr_dbg("fx2lafw: Found an fx2lafw device."); | |
488 | sdi->status = SR_ST_INACTIVE; | |
489 | devc->usb = sr_usb_dev_inst_new | |
490 | (libusb_get_bus_number(devlist[i]), | |
491 | libusb_get_device_address(devlist[i]), NULL); | |
492 | } else { | |
493 | if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION, | |
494 | prof->firmware) == SR_OK) | |
495 | /* Remember when the firmware on this device was updated */ | |
496 | devc->fw_updated = g_get_monotonic_time(); | |
497 | else | |
498 | sr_err("fx2lafw: Firmware upload failed for " | |
499 | "device %d.", devcnt); | |
500 | devc->usb = sr_usb_dev_inst_new | |
501 | (libusb_get_bus_number(devlist[i]), 0xff, NULL); | |
502 | } | |
503 | } | |
504 | libusb_free_device_list(devlist, 1); | |
505 | ||
506 | return devices; | |
507 | } | |
508 | ||
509 | static GSList *hw_dev_list(void) | |
510 | { | |
511 | struct drv_context *drvc; | |
512 | ||
513 | drvc = fdi->priv; | |
514 | ||
515 | return drvc->instances; | |
516 | } | |
517 | ||
518 | static int hw_dev_open(struct sr_dev_inst *sdi) | |
519 | { | |
520 | struct dev_context *devc; | |
521 | int ret; | |
522 | int64_t timediff_us, timediff_ms; | |
523 | ||
524 | devc = sdi->priv; | |
525 | ||
526 | /* | |
527 | * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS | |
528 | * milliseconds for the FX2 to renumerate. | |
529 | */ | |
530 | ret = SR_ERR; | |
531 | if (devc->fw_updated > 0) { | |
532 | sr_info("fx2lafw: Waiting for device to reset."); | |
533 | /* takes at least 300ms for the FX2 to be gone from the USB bus */ | |
534 | g_usleep(300 * 1000); | |
535 | timediff_ms = 0; | |
536 | while (timediff_ms < MAX_RENUM_DELAY_MS) { | |
537 | if ((ret = fx2lafw_dev_open(sdi)) == SR_OK) | |
538 | break; | |
539 | g_usleep(100 * 1000); | |
540 | ||
541 | timediff_us = g_get_monotonic_time() - devc->fw_updated; | |
542 | timediff_ms = timediff_us / 1000; | |
543 | sr_spew("fx2lafw: waited %" PRIi64 " ms", timediff_ms); | |
544 | } | |
545 | } else { | |
546 | ret = fx2lafw_dev_open(sdi); | |
547 | } | |
548 | ||
549 | if (ret != SR_OK) { | |
550 | sr_err("fx2lafw: Unable to open device."); | |
551 | return SR_ERR; | |
552 | } else { | |
553 | sr_info("fx2lafw: Device came back after %d ms.", | |
554 | timediff_ms); | |
555 | } | |
556 | ||
557 | devc = sdi->priv; | |
558 | ||
559 | ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE); | |
560 | if (ret != 0) { | |
561 | switch(ret) { | |
562 | case LIBUSB_ERROR_BUSY: | |
563 | sr_err("fx2lafw: Unable to claim USB interface. Another " | |
564 | "program or driver has already claimed it."); | |
565 | break; | |
566 | ||
567 | case LIBUSB_ERROR_NO_DEVICE: | |
568 | sr_err("fx2lafw: Device has been disconnected."); | |
569 | break; | |
570 | ||
571 | default: | |
572 | sr_err("fx2lafw: Unable to claim interface: %s.", | |
573 | libusb_error_name(ret)); | |
574 | break; | |
575 | } | |
576 | ||
577 | return SR_ERR; | |
578 | } | |
579 | ||
580 | if (devc->cur_samplerate == 0) { | |
581 | /* Samplerate hasn't been set; default to the slowest one. */ | |
582 | if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE, | |
583 | &supported_samplerates[0]) == SR_ERR) | |
584 | return SR_ERR; | |
585 | } | |
586 | ||
587 | return SR_OK; | |
588 | } | |
589 | ||
590 | static int hw_dev_close(struct sr_dev_inst *sdi) | |
591 | { | |
592 | struct dev_context *devc; | |
593 | ||
594 | devc = sdi->priv; | |
595 | if (devc->usb->devhdl == NULL) | |
596 | return SR_ERR; | |
597 | ||
598 | sr_info("fx2lafw: Closing device %d on %d.%d interface %d.", | |
599 | sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE); | |
600 | libusb_release_interface(devc->usb->devhdl, USB_INTERFACE); | |
601 | libusb_close(devc->usb->devhdl); | |
602 | devc->usb->devhdl = NULL; | |
603 | sdi->status = SR_ST_INACTIVE; | |
604 | ||
605 | return SR_OK; | |
606 | } | |
607 | ||
608 | static int hw_cleanup(void) | |
609 | { | |
610 | struct drv_context *drvc; | |
611 | int ret; | |
612 | ||
613 | if (!(drvc = fdi->priv)) | |
614 | return SR_OK; | |
615 | ||
616 | ret = clear_instances(); | |
617 | ||
618 | g_free(drvc); | |
619 | fdi->priv = NULL; | |
620 | ||
621 | return ret; | |
622 | } | |
623 | ||
624 | static int hw_info_get(int info_id, const void **data, | |
625 | const struct sr_dev_inst *sdi) | |
626 | { | |
627 | struct dev_context *devc; | |
628 | ||
629 | switch (info_id) { | |
630 | case SR_DI_HWCAPS: | |
631 | *data = hwcaps; | |
632 | break; | |
633 | case SR_DI_NUM_PROBES: | |
634 | if (sdi) { | |
635 | devc = sdi->priv; | |
636 | *data = GINT_TO_POINTER( | |
637 | (devc->profile->dev_caps & DEV_CAPS_16BIT) ? | |
638 | 16 : 8); | |
639 | } else | |
640 | return SR_ERR; | |
641 | break; | |
642 | case SR_DI_PROBE_NAMES: | |
643 | *data = probe_names; | |
644 | break; | |
645 | case SR_DI_SAMPLERATES: | |
646 | *data = &samplerates; | |
647 | break; | |
648 | case SR_DI_TRIGGER_TYPES: | |
649 | *data = TRIGGER_TYPES; | |
650 | break; | |
651 | case SR_DI_CUR_SAMPLERATE: | |
652 | if (sdi) { | |
653 | devc = sdi->priv; | |
654 | *data = &devc->cur_samplerate; | |
655 | } else | |
656 | return SR_ERR; | |
657 | break; | |
658 | default: | |
659 | return SR_ERR_ARG; | |
660 | } | |
661 | ||
662 | return SR_OK; | |
663 | } | |
664 | ||
665 | static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, | |
666 | const void *value) | |
667 | { | |
668 | struct dev_context *devc; | |
669 | int ret; | |
670 | ||
671 | devc = sdi->priv; | |
672 | ||
673 | if (hwcap == SR_HWCAP_SAMPLERATE) { | |
674 | devc->cur_samplerate = *(const uint64_t *)value; | |
675 | ret = SR_OK; | |
676 | } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) { | |
677 | devc->limit_samples = *(const uint64_t *)value; | |
678 | ret = SR_OK; | |
679 | } else { | |
680 | ret = SR_ERR; | |
681 | } | |
682 | ||
683 | return ret; | |
684 | } | |
685 | ||
686 | static int receive_data(int fd, int revents, void *cb_data) | |
687 | { | |
688 | struct timeval tv; | |
689 | struct drv_context *drvc = fdi->priv; | |
690 | ||
691 | (void)fd; | |
692 | (void)revents; | |
693 | (void)cb_data; | |
694 | ||
695 | tv.tv_sec = tv.tv_usec = 0; | |
696 | libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv); | |
697 | ||
698 | return TRUE; | |
699 | } | |
700 | ||
701 | static void abort_acquisition(struct dev_context *devc) | |
702 | { | |
703 | int i; | |
704 | ||
705 | devc->num_samples = -1; | |
706 | ||
707 | for (i = devc->num_transfers - 1; i >= 0; i--) { | |
708 | if (devc->transfers[i]) | |
709 | libusb_cancel_transfer(devc->transfers[i]); | |
710 | } | |
711 | } | |
712 | ||
713 | static void finish_acquisition(struct dev_context *devc) | |
714 | { | |
715 | struct sr_datafeed_packet packet; | |
716 | struct drv_context *drvc = fdi->priv; | |
717 | int i; | |
718 | ||
719 | ||
720 | /* Terminate session */ | |
721 | packet.type = SR_DF_END; | |
722 | sr_session_send(devc->session_dev_id, &packet); | |
723 | ||
724 | /* Remove fds from polling */ | |
725 | const struct libusb_pollfd **const lupfd = | |
726 | libusb_get_pollfds(drvc->sr_ctx->libusb_ctx); | |
727 | for (i = 0; lupfd[i]; i++) | |
728 | sr_source_remove(lupfd[i]->fd); | |
729 | free(lupfd); /* NOT g_free()! */ | |
730 | ||
731 | devc->num_transfers = 0; | |
732 | g_free(devc->transfers); | |
733 | } | |
734 | ||
735 | static void free_transfer(struct libusb_transfer *transfer) | |
736 | { | |
737 | struct dev_context *devc = transfer->user_data; | |
738 | unsigned int i; | |
739 | ||
740 | g_free(transfer->buffer); | |
741 | transfer->buffer = NULL; | |
742 | libusb_free_transfer(transfer); | |
743 | ||
744 | for (i = 0; i < devc->num_transfers; i++) { | |
745 | if (devc->transfers[i] == transfer) { | |
746 | devc->transfers[i] = NULL; | |
747 | break; | |
748 | } | |
749 | } | |
750 | ||
751 | devc->submitted_transfers--; | |
752 | if (devc->submitted_transfers == 0) | |
753 | finish_acquisition(devc); | |
754 | ||
755 | } | |
756 | ||
757 | static void resubmit_transfer(struct libusb_transfer *transfer) | |
758 | { | |
759 | int ret = libusb_submit_transfer(transfer); | |
760 | ||
761 | if (LIBUSB_SUCCESS == ret) | |
762 | return; | |
763 | ||
764 | free_transfer(transfer); | |
765 | /* TODO: Stop session? */ | |
766 | ||
767 | sr_err("fx2lafw: %s: %s", __func__, libusb_error_name(ret)); | |
768 | } | |
769 | ||
770 | static void receive_transfer(struct libusb_transfer *transfer) | |
771 | { | |
772 | gboolean packet_has_error = FALSE; | |
773 | struct sr_datafeed_packet packet; | |
774 | struct sr_datafeed_logic logic; | |
775 | struct dev_context *devc = transfer->user_data; | |
776 | int trigger_offset, i; | |
777 | ||
778 | /* | |
779 | * If acquisition has already ended, just free any queued up | |
780 | * transfer that come in. | |
781 | */ | |
782 | if (devc->num_samples == -1) { | |
783 | free_transfer(transfer); | |
784 | return; | |
785 | } | |
786 | ||
787 | sr_info("fx2lafw: receive_transfer(): status %d received %d bytes.", | |
788 | transfer->status, transfer->actual_length); | |
789 | ||
790 | /* Save incoming transfer before reusing the transfer struct. */ | |
791 | uint8_t *const cur_buf = transfer->buffer; | |
792 | const int sample_width = devc->sample_wide ? 2 : 1; | |
793 | const int cur_sample_count = transfer->actual_length / sample_width; | |
794 | ||
795 | switch (transfer->status) { | |
796 | case LIBUSB_TRANSFER_NO_DEVICE: | |
797 | abort_acquisition(devc); | |
798 | free_transfer(transfer); | |
799 | return; | |
800 | case LIBUSB_TRANSFER_COMPLETED: | |
801 | case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */ | |
802 | break; | |
803 | default: | |
804 | packet_has_error = TRUE; | |
805 | break; | |
806 | } | |
807 | ||
808 | if (transfer->actual_length == 0 || packet_has_error) { | |
809 | devc->empty_transfer_count++; | |
810 | if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) { | |
811 | /* | |
812 | * The FX2 gave up. End the acquisition, the frontend | |
813 | * will work out that the samplecount is short. | |
814 | */ | |
815 | abort_acquisition(devc); | |
816 | free_transfer(transfer); | |
817 | } else { | |
818 | resubmit_transfer(transfer); | |
819 | } | |
820 | return; | |
821 | } else { | |
822 | devc->empty_transfer_count = 0; | |
823 | } | |
824 | ||
825 | trigger_offset = 0; | |
826 | if (devc->trigger_stage >= 0) { | |
827 | for (i = 0; i < cur_sample_count; i++) { | |
828 | ||
829 | const uint16_t cur_sample = devc->sample_wide ? | |
830 | *((const uint16_t*)cur_buf + i) : | |
831 | *((const uint8_t*)cur_buf + i); | |
832 | ||
833 | if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) == | |
834 | devc->trigger_value[devc->trigger_stage]) { | |
835 | /* Match on this trigger stage. */ | |
836 | devc->trigger_buffer[devc->trigger_stage] = cur_sample; | |
837 | devc->trigger_stage++; | |
838 | ||
839 | if (devc->trigger_stage == NUM_TRIGGER_STAGES || | |
840 | devc->trigger_mask[devc->trigger_stage] == 0) { | |
841 | /* Match on all trigger stages, we're done. */ | |
842 | trigger_offset = i + 1; | |
843 | ||
844 | /* | |
845 | * TODO: Send pre-trigger buffer to session bus. | |
846 | * Tell the frontend we hit the trigger here. | |
847 | */ | |
848 | packet.type = SR_DF_TRIGGER; | |
849 | packet.payload = NULL; | |
850 | sr_session_send(devc->session_dev_id, &packet); | |
851 | ||
852 | /* | |
853 | * Send the samples that triggered it, since we're | |
854 | * skipping past them. | |
855 | */ | |
856 | packet.type = SR_DF_LOGIC; | |
857 | packet.payload = &logic; | |
858 | logic.unitsize = sizeof(*devc->trigger_buffer); | |
859 | logic.length = devc->trigger_stage * logic.unitsize; | |
860 | logic.data = devc->trigger_buffer; | |
861 | sr_session_send(devc->session_dev_id, &packet); | |
862 | ||
863 | devc->trigger_stage = TRIGGER_FIRED; | |
864 | break; | |
865 | } | |
866 | } else if (devc->trigger_stage > 0) { | |
867 | /* | |
868 | * We had a match before, but not in the next sample. However, we may | |
869 | * have a match on this stage in the next bit -- trigger on 0001 will | |
870 | * fail on seeing 00001, so we need to go back to stage 0 -- but at | |
871 | * the next sample from the one that matched originally, which the | |
872 | * counter increment at the end of the loop takes care of. | |
873 | */ | |
874 | i -= devc->trigger_stage; | |
875 | if (i < -1) | |
876 | i = -1; /* Oops, went back past this buffer. */ | |
877 | /* Reset trigger stage. */ | |
878 | devc->trigger_stage = 0; | |
879 | } | |
880 | } | |
881 | } | |
882 | ||
883 | if (devc->trigger_stage == TRIGGER_FIRED) { | |
884 | /* Send the incoming transfer to the session bus. */ | |
885 | const int trigger_offset_bytes = trigger_offset * sample_width; | |
886 | packet.type = SR_DF_LOGIC; | |
887 | packet.payload = &logic; | |
888 | logic.length = transfer->actual_length - trigger_offset_bytes; | |
889 | logic.unitsize = sample_width; | |
890 | logic.data = cur_buf + trigger_offset_bytes; | |
891 | sr_session_send(devc->session_dev_id, &packet); | |
892 | ||
893 | devc->num_samples += cur_sample_count; | |
894 | if (devc->limit_samples && | |
895 | (unsigned int)devc->num_samples > devc->limit_samples) { | |
896 | abort_acquisition(devc); | |
897 | free_transfer(transfer); | |
898 | return; | |
899 | } | |
900 | } else { | |
901 | /* | |
902 | * TODO: Buffer pre-trigger data in capture | |
903 | * ratio-sized buffer. | |
904 | */ | |
905 | } | |
906 | ||
907 | resubmit_transfer(transfer); | |
908 | } | |
909 | ||
910 | static unsigned int to_bytes_per_ms(unsigned int samplerate) | |
911 | { | |
912 | return samplerate / 1000; | |
913 | } | |
914 | ||
915 | static size_t get_buffer_size(struct dev_context *devc) | |
916 | { | |
917 | size_t s; | |
918 | ||
919 | /* The buffer should be large enough to hold 10ms of data and a multiple | |
920 | * of 512. */ | |
921 | s = 10 * to_bytes_per_ms(devc->cur_samplerate); | |
922 | return (s + 511) & ~511; | |
923 | } | |
924 | ||
925 | static unsigned int get_number_of_transfers(struct dev_context *devc) | |
926 | { | |
927 | unsigned int n; | |
928 | ||
929 | /* Total buffer size should be able to hold about 500ms of data */ | |
930 | n = 500 * to_bytes_per_ms(devc->cur_samplerate) / get_buffer_size(devc); | |
931 | ||
932 | if (n > NUM_SIMUL_TRANSFERS) | |
933 | return NUM_SIMUL_TRANSFERS; | |
934 | ||
935 | return n; | |
936 | } | |
937 | ||
938 | static unsigned int get_timeout(struct dev_context *devc) | |
939 | { | |
940 | size_t total_size; | |
941 | unsigned int timeout; | |
942 | ||
943 | total_size = get_buffer_size(devc) * get_number_of_transfers(devc); | |
944 | timeout = total_size / to_bytes_per_ms(devc->cur_samplerate); | |
945 | return timeout + timeout / 4; /* Leave a headroom of 25% percent */ | |
946 | } | |
947 | ||
948 | static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi, | |
949 | void *cb_data) | |
950 | { | |
951 | struct sr_datafeed_packet packet; | |
952 | struct sr_datafeed_header header; | |
953 | struct sr_datafeed_meta_logic meta; | |
954 | struct dev_context *devc; | |
955 | struct drv_context *drvc = fdi->priv; | |
956 | struct libusb_transfer *transfer; | |
957 | const struct libusb_pollfd **lupfd; | |
958 | unsigned int i; | |
959 | int ret; | |
960 | unsigned char *buf; | |
961 | ||
962 | devc = sdi->priv; | |
963 | if (devc->submitted_transfers != 0) | |
964 | return SR_ERR; | |
965 | ||
966 | if (configure_probes(sdi) != SR_OK) { | |
967 | sr_err("fx2lafw: failed to configured probes"); | |
968 | return SR_ERR; | |
969 | } | |
970 | ||
971 | devc->session_dev_id = cb_data; | |
972 | devc->num_samples = 0; | |
973 | devc->empty_transfer_count = 0; | |
974 | ||
975 | const unsigned int timeout = get_timeout(devc); | |
976 | const unsigned int num_transfers = get_number_of_transfers(devc); | |
977 | const size_t size = get_buffer_size(devc); | |
978 | ||
979 | devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers); | |
980 | if (!devc->transfers) { | |
981 | sr_err("fx2lafw: USB transfers malloc failed."); | |
982 | return SR_ERR_MALLOC; | |
983 | } | |
984 | ||
985 | devc->num_transfers = num_transfers; | |
986 | ||
987 | for (i = 0; i < num_transfers; i++) { | |
988 | if (!(buf = g_try_malloc(size))) { | |
989 | sr_err("fx2lafw: %s: buf malloc failed.", __func__); | |
990 | return SR_ERR_MALLOC; | |
991 | } | |
992 | transfer = libusb_alloc_transfer(0); | |
993 | libusb_fill_bulk_transfer(transfer, devc->usb->devhdl, | |
994 | 2 | LIBUSB_ENDPOINT_IN, buf, size, | |
995 | receive_transfer, devc, timeout); | |
996 | if ((ret = libusb_submit_transfer(transfer)) != 0) { | |
997 | sr_err("fx2lafw: %s: libusb_submit_transfer: %s.", | |
998 | __func__, libusb_error_name(ret)); | |
999 | libusb_free_transfer(transfer); | |
1000 | g_free(buf); | |
1001 | abort_acquisition(devc); | |
1002 | return SR_ERR; | |
1003 | } | |
1004 | devc->transfers[i] = transfer; | |
1005 | devc->submitted_transfers++; | |
1006 | } | |
1007 | ||
1008 | lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx); | |
1009 | for (i = 0; lupfd[i]; i++) | |
1010 | sr_source_add(lupfd[i]->fd, lupfd[i]->events, | |
1011 | timeout, receive_data, NULL); | |
1012 | free(lupfd); /* NOT g_free()! */ | |
1013 | ||
1014 | packet.type = SR_DF_HEADER; | |
1015 | packet.payload = &header; | |
1016 | header.feed_version = 1; | |
1017 | gettimeofday(&header.starttime, NULL); | |
1018 | sr_session_send(cb_data, &packet); | |
1019 | ||
1020 | /* Send metadata about the SR_DF_LOGIC packets to come. */ | |
1021 | packet.type = SR_DF_META_LOGIC; | |
1022 | packet.payload = &meta; | |
1023 | meta.samplerate = devc->cur_samplerate; | |
1024 | meta.num_probes = devc->sample_wide ? 16 : 8; | |
1025 | sr_session_send(cb_data, &packet); | |
1026 | ||
1027 | if ((ret = command_start_acquisition (devc->usb->devhdl, | |
1028 | devc->cur_samplerate, devc->sample_wide)) != SR_OK) { | |
1029 | abort_acquisition(devc); | |
1030 | return ret; | |
1031 | } | |
1032 | ||
1033 | return SR_OK; | |
1034 | } | |
1035 | ||
1036 | /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */ | |
1037 | static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) | |
1038 | { | |
1039 | (void)cb_data; | |
1040 | ||
1041 | abort_acquisition(sdi->priv); | |
1042 | ||
1043 | return SR_OK; | |
1044 | } | |
1045 | ||
1046 | SR_PRIV struct sr_dev_driver fx2lafw_driver_info = { | |
1047 | .name = "fx2lafw", | |
1048 | .longname = "fx2lafw (generic driver for FX2 based LAs)", | |
1049 | .api_version = 1, | |
1050 | .init = hw_init, | |
1051 | .cleanup = hw_cleanup, | |
1052 | .scan = hw_scan, | |
1053 | .dev_list = hw_dev_list, | |
1054 | .dev_clear = clear_instances, | |
1055 | .dev_open = hw_dev_open, | |
1056 | .dev_close = hw_dev_close, | |
1057 | .info_get = hw_info_get, | |
1058 | .dev_config_set = hw_dev_config_set, | |
1059 | .dev_acquisition_start = hw_dev_acquisition_start, | |
1060 | .dev_acquisition_stop = hw_dev_acquisition_stop, | |
1061 | .priv = NULL, | |
1062 | }; |