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