]> 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
Add driver helper std_dev_clear()
[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 struct drv_context *drvc;
384 struct dev_context *devc;
385 struct sr_dev_inst *sdi;
386 struct sr_usb_dev_inst *usb;
387 struct sr_probe *probe;
388 struct sr_config *src;
389 const struct fx2lafw_profile *prof;
390 GSList *l, *devices, *conn_devices;
391 struct libusb_device_descriptor des;
392 libusb_device **devlist;
393 int devcnt, num_logic_probes, ret, i, j;
394 const char *conn;
395
396 (void)options;
397
398 drvc = di->priv;
399
400 /* This scan always invalidates any previous scans. */
401 clear_instances();
402
403 conn = NULL;
404 for (l = options; l; l = l->next) {
405 src = l->data;
406 switch (src->key) {
407 case SR_CONF_CONN:
408 conn = g_variant_get_string(src->data, NULL);
409 break;
410 }
411 }
412 if (conn)
413 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
414 else
415 conn_devices = NULL;
416
417 /* Find all fx2lafw compatible devices and upload firmware to them. */
418 devices = NULL;
419 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
420 for (i = 0; devlist[i]; i++) {
421 if (conn) {
422 usb = NULL;
423 for (l = conn_devices; l; l = l->next) {
424 usb = l->data;
425 if (usb->bus == libusb_get_bus_number(devlist[i])
426 && usb->address == libusb_get_device_address(devlist[i]))
427 break;
428 }
429 if (!l)
430 /* This device matched none of the ones that
431 * matched the conn specification. */
432 continue;
433 }
434
435 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
436 sr_warn("Failed to get device descriptor: %s.",
437 libusb_error_name(ret));
438 continue;
439 }
440
441 prof = NULL;
442 for (j = 0; supported_fx2[j].vid; j++) {
443 if (des.idVendor == supported_fx2[j].vid &&
444 des.idProduct == supported_fx2[j].pid) {
445 prof = &supported_fx2[j];
446 }
447 }
448
449 /* Skip if the device was not found. */
450 if (!prof)
451 continue;
452
453 devcnt = g_slist_length(drvc->instances);
454 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
455 prof->vendor, prof->model, prof->model_version);
456 if (!sdi)
457 return NULL;
458 sdi->driver = di;
459
460 /* Fill in probelist according to this device's profile. */
461 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
462 for (j = 0; j < num_logic_probes; j++) {
463 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
464 probe_names[j])))
465 return NULL;
466 sdi->probes = g_slist_append(sdi->probes, probe);
467 }
468
469 devc = fx2lafw_dev_new();
470 devc->profile = prof;
471 sdi->priv = devc;
472 drvc->instances = g_slist_append(drvc->instances, sdi);
473 devices = g_slist_append(devices, sdi);
474
475 if (check_conf_profile(devlist[i])) {
476 /* Already has the firmware, so fix the new address. */
477 sr_dbg("Found an fx2lafw device.");
478 sdi->status = SR_ST_INACTIVE;
479 devc->usb = sr_usb_dev_inst_new
480 (libusb_get_bus_number(devlist[i]),
481 libusb_get_device_address(devlist[i]), NULL);
482 } else {
483 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
484 prof->firmware) == SR_OK)
485 /* Store when this device's FW was updated. */
486 devc->fw_updated = g_get_monotonic_time();
487 else
488 sr_err("Firmware upload failed for "
489 "device %d.", devcnt);
490 devc->usb = sr_usb_dev_inst_new
491 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
492 }
493 }
494 libusb_free_device_list(devlist, 1);
495
496 return devices;
497}
498
499static GSList *hw_dev_list(void)
500{
501 return ((struct drv_context *)(di->priv))->instances;
502}
503
504static int hw_dev_open(struct sr_dev_inst *sdi)
505{
506 struct dev_context *devc;
507 int ret;
508 int64_t timediff_us, timediff_ms;
509
510 devc = sdi->priv;
511
512 /*
513 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
514 * milliseconds for the FX2 to renumerate.
515 */
516 ret = SR_ERR;
517 if (devc->fw_updated > 0) {
518 sr_info("Waiting for device to reset.");
519 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
520 g_usleep(300 * 1000);
521 timediff_ms = 0;
522 while (timediff_ms < MAX_RENUM_DELAY_MS) {
523 if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
524 break;
525 g_usleep(100 * 1000);
526
527 timediff_us = g_get_monotonic_time() - devc->fw_updated;
528 timediff_ms = timediff_us / 1000;
529 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
530 }
531 if (ret != SR_OK) {
532 sr_err("Device failed to renumerate.");
533 return SR_ERR;
534 }
535 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
536 } else {
537 sr_info("Firmware upload was not needed.");
538 ret = fx2lafw_dev_open(sdi);
539 }
540
541 if (ret != SR_OK) {
542 sr_err("Unable to open device.");
543 return SR_ERR;
544 }
545
546 devc = sdi->priv;
547
548 ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
549 if (ret != 0) {
550 switch(ret) {
551 case LIBUSB_ERROR_BUSY:
552 sr_err("Unable to claim USB interface. Another "
553 "program or driver has already claimed it.");
554 break;
555 case LIBUSB_ERROR_NO_DEVICE:
556 sr_err("Device has been disconnected.");
557 break;
558 default:
559 sr_err("Unable to claim interface: %s.",
560 libusb_error_name(ret));
561 break;
562 }
563
564 return SR_ERR;
565 }
566
567 if (devc->cur_samplerate == 0) {
568 /* Samplerate hasn't been set; default to the slowest one. */
569 devc->cur_samplerate = samplerates[0];
570 }
571
572 return SR_OK;
573}
574
575static int hw_dev_close(struct sr_dev_inst *sdi)
576{
577 struct dev_context *devc;
578
579 devc = sdi->priv;
580
581 if (devc->usb->devhdl == NULL)
582 return SR_ERR;
583
584 sr_info("Closing device %d on %d.%d, interface %d.",
585 sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE);
586 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
587 libusb_close(devc->usb->devhdl);
588 devc->usb->devhdl = NULL;
589 sdi->status = SR_ST_INACTIVE;
590
591 return SR_OK;
592}
593
594static int hw_cleanup(void)
595{
596 struct drv_context *drvc;
597 int ret;
598
599 if (!(drvc = di->priv))
600 return SR_OK;
601
602 ret = clear_instances();
603
604 g_free(drvc);
605 di->priv = NULL;
606
607 return ret;
608}
609
610static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
611{
612 struct dev_context *devc;
613
614 switch (id) {
615 case SR_CONF_SAMPLERATE:
616 if (sdi) {
617 devc = sdi->priv;
618 *data = g_variant_new_uint64(devc->cur_samplerate);
619 } else
620 return SR_ERR;
621 break;
622 default:
623 return SR_ERR_NA;
624 }
625
626 return SR_OK;
627}
628
629static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
630{
631 struct dev_context *devc;
632 int ret;
633
634 devc = sdi->priv;
635
636 if (id == SR_CONF_SAMPLERATE) {
637 devc->cur_samplerate = g_variant_get_uint64(data);
638 ret = SR_OK;
639 } else if (id == SR_CONF_LIMIT_SAMPLES) {
640 devc->limit_samples = g_variant_get_uint64(data);
641 ret = SR_OK;
642 } else {
643 ret = SR_ERR_NA;
644 }
645
646 return ret;
647}
648
649static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
650{
651 GVariant *gvar;
652 GVariantBuilder gvb;
653
654 (void)sdi;
655
656 switch (key) {
657 case SR_CONF_DEVICE_OPTIONS:
658 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
659 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
660 break;
661 case SR_CONF_SAMPLERATE:
662 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
663 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
664 ARRAY_SIZE(samplerates), sizeof(uint64_t));
665 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
666 *data = g_variant_builder_end(&gvb);
667 break;
668 case SR_CONF_TRIGGER_TYPE:
669 *data = g_variant_new_string(TRIGGER_TYPE);
670 break;
671 default:
672 return SR_ERR_NA;
673 }
674
675 return SR_OK;
676}
677
678static int receive_data(int fd, int revents, void *cb_data)
679{
680 struct timeval tv;
681 struct drv_context *drvc;
682
683 (void)fd;
684 (void)revents;
685 (void)cb_data;
686
687 drvc = di->priv;
688
689 tv.tv_sec = tv.tv_usec = 0;
690 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
691
692 return TRUE;
693}
694
695static void abort_acquisition(struct dev_context *devc)
696{
697 int i;
698
699 devc->num_samples = -1;
700
701 for (i = devc->num_transfers - 1; i >= 0; i--) {
702 if (devc->transfers[i])
703 libusb_cancel_transfer(devc->transfers[i]);
704 }
705}
706
707static void finish_acquisition(struct dev_context *devc)
708{
709 struct sr_datafeed_packet packet;
710 struct drv_context *drvc = di->priv;
711 const struct libusb_pollfd **lupfd;
712 int i;
713
714 /* Terminate session. */
715 packet.type = SR_DF_END;
716 sr_session_send(devc->cb_data, &packet);
717
718 /* Remove fds from polling. */
719 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
720 for (i = 0; lupfd[i]; i++)
721 sr_source_remove(lupfd[i]->fd);
722 free(lupfd); /* NOT g_free()! */
723
724 devc->num_transfers = 0;
725 g_free(devc->transfers);
726}
727
728static void free_transfer(struct libusb_transfer *transfer)
729{
730 struct dev_context *devc;
731 unsigned int i;
732
733 devc = transfer->user_data;
734
735 g_free(transfer->buffer);
736 transfer->buffer = NULL;
737 libusb_free_transfer(transfer);
738
739 for (i = 0; i < devc->num_transfers; i++) {
740 if (devc->transfers[i] == transfer) {
741 devc->transfers[i] = NULL;
742 break;
743 }
744 }
745
746 devc->submitted_transfers--;
747 if (devc->submitted_transfers == 0)
748 finish_acquisition(devc);
749}
750
751static void resubmit_transfer(struct libusb_transfer *transfer)
752{
753 int ret;
754
755 if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
756 return;
757
758 free_transfer(transfer);
759 /* TODO: Stop session? */
760
761 sr_err("%s: %s", __func__, libusb_error_name(ret));
762}
763
764static void receive_transfer(struct libusb_transfer *transfer)
765{
766 gboolean packet_has_error = FALSE;
767 struct sr_datafeed_packet packet;
768 struct sr_datafeed_logic logic;
769 struct dev_context *devc;
770 int trigger_offset, i, sample_width, cur_sample_count;
771 int trigger_offset_bytes;
772 uint8_t *cur_buf;
773
774 devc = transfer->user_data;
775
776 /*
777 * If acquisition has already ended, just free any queued up
778 * transfer that come in.
779 */
780 if (devc->num_samples == -1) {
781 free_transfer(transfer);
782 return;
783 }
784
785 sr_info("receive_transfer(): status %d received %d bytes.",
786 transfer->status, transfer->actual_length);
787
788 /* Save incoming transfer before reusing the transfer struct. */
789 cur_buf = transfer->buffer;
790 sample_width = devc->sample_wide ? 2 : 1;
791 cur_sample_count = transfer->actual_length / sample_width;
792
793 switch (transfer->status) {
794 case LIBUSB_TRANSFER_NO_DEVICE:
795 abort_acquisition(devc);
796 free_transfer(transfer);
797 return;
798 case LIBUSB_TRANSFER_COMPLETED:
799 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
800 break;
801 default:
802 packet_has_error = TRUE;
803 break;
804 }
805
806 if (transfer->actual_length == 0 || packet_has_error) {
807 devc->empty_transfer_count++;
808 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
809 /*
810 * The FX2 gave up. End the acquisition, the frontend
811 * will work out that the samplecount is short.
812 */
813 abort_acquisition(devc);
814 free_transfer(transfer);
815 } else {
816 resubmit_transfer(transfer);
817 }
818 return;
819 } else {
820 devc->empty_transfer_count = 0;
821 }
822
823 trigger_offset = 0;
824 if (devc->trigger_stage >= 0) {
825 for (i = 0; i < cur_sample_count; i++) {
826
827 const uint16_t cur_sample = devc->sample_wide ?
828 *((const uint16_t*)cur_buf + i) :
829 *((const uint8_t*)cur_buf + i);
830
831 if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) ==
832 devc->trigger_value[devc->trigger_stage]) {
833 /* Match on this trigger stage. */
834 devc->trigger_buffer[devc->trigger_stage] = cur_sample;
835 devc->trigger_stage++;
836
837 if (devc->trigger_stage == NUM_TRIGGER_STAGES ||
838 devc->trigger_mask[devc->trigger_stage] == 0) {
839 /* Match on all trigger stages, we're done. */
840 trigger_offset = i + 1;
841
842 /*
843 * TODO: Send pre-trigger buffer to session bus.
844 * Tell the frontend we hit the trigger here.
845 */
846 packet.type = SR_DF_TRIGGER;
847 packet.payload = NULL;
848 sr_session_send(devc->cb_data, &packet);
849
850 /*
851 * Send the samples that triggered it,
852 * since we're skipping past them.
853 */
854 packet.type = SR_DF_LOGIC;
855 packet.payload = &logic;
856 logic.unitsize = sizeof(*devc->trigger_buffer);
857 logic.length = devc->trigger_stage * logic.unitsize;
858 logic.data = devc->trigger_buffer;
859 sr_session_send(devc->cb_data, &packet);
860
861 devc->trigger_stage = TRIGGER_FIRED;
862 break;
863 }
864 } else if (devc->trigger_stage > 0) {
865 /*
866 * We had a match before, but not in the next sample. However, we may
867 * have a match on this stage in the next bit -- trigger on 0001 will
868 * fail on seeing 00001, so we need to go back to stage 0 -- but at
869 * the next sample from the one that matched originally, which the
870 * counter increment at the end of the loop takes care of.
871 */
872 i -= devc->trigger_stage;
873 if (i < -1)
874 i = -1; /* Oops, went back past this buffer. */
875 /* Reset trigger stage. */
876 devc->trigger_stage = 0;
877 }
878 }
879 }
880
881 if (devc->trigger_stage == TRIGGER_FIRED) {
882 /* Send the incoming transfer to the session bus. */
883 trigger_offset_bytes = trigger_offset * sample_width;
884 packet.type = SR_DF_LOGIC;
885 packet.payload = &logic;
886 logic.length = transfer->actual_length - trigger_offset_bytes;
887 logic.unitsize = sample_width;
888 logic.data = cur_buf + trigger_offset_bytes;
889 sr_session_send(devc->cb_data, &packet);
890
891 devc->num_samples += cur_sample_count;
892 if (devc->limit_samples &&
893 (unsigned int)devc->num_samples > devc->limit_samples) {
894 abort_acquisition(devc);
895 free_transfer(transfer);
896 return;
897 }
898 } else {
899 /*
900 * TODO: Buffer pre-trigger data in capture
901 * ratio-sized buffer.
902 */
903 }
904
905 resubmit_transfer(transfer);
906}
907
908static unsigned int to_bytes_per_ms(unsigned int samplerate)
909{
910 return samplerate / 1000;
911}
912
913static size_t get_buffer_size(struct dev_context *devc)
914{
915 size_t s;
916
917 /*
918 * The buffer should be large enough to hold 10ms of data and
919 * a multiple of 512.
920 */
921 s = 10 * to_bytes_per_ms(devc->cur_samplerate);
922 return (s + 511) & ~511;
923}
924
925static 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
938static 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
948static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
949 void *cb_data)
950{
951 struct dev_context *devc;
952 struct drv_context *drvc;
953 struct libusb_transfer *transfer;
954 const struct libusb_pollfd **lupfd;
955 unsigned int i, timeout, num_transfers;
956 int ret;
957 unsigned char *buf;
958 size_t size;
959
960 drvc = di->priv;
961 devc = sdi->priv;
962
963 if (devc->submitted_transfers != 0)
964 return SR_ERR;
965
966 if (configure_probes(sdi) != SR_OK) {
967 sr_err("Failed to configure probes.");
968 return SR_ERR;
969 }
970
971 devc->cb_data = cb_data;
972 devc->num_samples = 0;
973 devc->empty_transfer_count = 0;
974
975 timeout = get_timeout(devc);
976 num_transfers = get_number_of_transfers(devc);
977 size = get_buffer_size(devc);
978
979 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
980 if (!devc->transfers) {
981 sr_err("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("USB transfer buffer malloc failed.");
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("Failed to submit transfer: %s.",
998 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 /* Send header packet to the session bus. */
1015 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
1016
1017 if ((ret = command_start_acquisition(devc->usb->devhdl,
1018 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1019 abort_acquisition(devc);
1020 return ret;
1021 }
1022
1023 return SR_OK;
1024}
1025
1026/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
1027static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
1028{
1029 (void)cb_data;
1030
1031 abort_acquisition(sdi->priv);
1032
1033 return SR_OK;
1034}
1035
1036SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
1037 .name = "fx2lafw",
1038 .longname = "fx2lafw (generic driver for FX2 based LAs)",
1039 .api_version = 1,
1040 .init = hw_init,
1041 .cleanup = hw_cleanup,
1042 .scan = hw_scan,
1043 .dev_list = hw_dev_list,
1044 .dev_clear = clear_instances,
1045 .config_get = config_get,
1046 .config_set = config_set,
1047 .config_list = config_list,
1048 .dev_open = hw_dev_open,
1049 .dev_close = hw_dev_close,
1050 .dev_acquisition_start = hw_dev_acquisition_start,
1051 .dev_acquisition_stop = hw_dev_acquisition_stop,
1052 .priv = NULL,
1053};
Hardware access and backend lib