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