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