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