]> sigrok.org Git - libsigrok.git/blame - hardware/fx2lafw/fx2lafw.c
Add driver helper std_dev_clear()
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
CommitLineData
f302a082
JH
1/*
2 * This file is part of the sigrok project.
3 *
13d8e03c 4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
f302a082
JH
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>
6b73d9a5 23#include <string.h>
8b35f474 24#include <inttypes.h>
187b3582 25#include <libusb.h>
45c59c8b
BV
26#include "libsigrok.h"
27#include "libsigrok-internal.h"
f302a082 28#include "fx2lafw.h"
f6582cd7 29#include "command.h"
f302a082 30
4679d14d 31static const struct fx2lafw_profile supported_fx2[] = {
7ae2f9d5
UH
32 /*
33 * CWAV USBee AX
17b6c75a 34 * EE Electronics ESLA201A
9f05304e 35 * ARMFLY AX-Pro
17b6c75a 36 */
f8b07fc6 37 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
d1ddc7a9
JH
38 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
39 0 },
0e8d0e24
IF
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 },
93a9f3da 47
7ae2f9d5
UH
48 /*
49 * CWAV USBee SX
4502e869
JH
50 */
51 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
d1ddc7a9
JH
52 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
53 0 },
4502e869 54
7ae2f9d5
UH
55 /*
56 * Saleae Logic
93a9f3da
JH
57 * EE Electronics ESLA100
58 * Robomotic MiniLogic
1663e470 59 * Robomotic BugLogic 3
93a9f3da
JH
60 */
61 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
d1ddc7a9
JH
62 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
63 0 },
93a9f3da 64
f488762a 65 /*
1663e470
UH
66 * Default Cypress FX2 without EEPROM, e.g.:
67 * Lcsoft Mini Board
68 * Braintechnology USB Interface V2.x
f488762a
JH
69 */
70 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
d1ddc7a9
JH
71 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
72 DEV_CAPS_16BIT },
f488762a 73
1663e470
UH
74 /*
75 * Braintechnology USB-LPS
76 */
77 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
d1ddc7a9
JH
78 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
79 DEV_CAPS_16BIT },
1663e470 80
f8b07fc6 81 { 0, 0, 0, 0, 0, 0, 0 }
187b3582
JH
82};
83
d6836bf1 84static const int32_t hwcaps[] = {
1953564a 85 SR_CONF_LOGIC_ANALYZER,
d6836bf1 86 SR_CONF_TRIGGER_TYPE,
1953564a 87 SR_CONF_SAMPLERATE,
8b35f474
JH
88
89 /* These are really implemented in the driver, not the hardware. */
1953564a
BV
90 SR_CONF_LIMIT_SAMPLES,
91 SR_CONF_CONTINUOUS,
8b35f474
JH
92};
93
da686568 94static const char *probe_names[] = {
b36e7153 95 "0", "1", "2", "3", "4", "5", "6", "7",
78693401
UH
96 "8", "9", "10", "11", "12", "13", "14", "15",
97 NULL,
8b35f474
JH
98};
99
d6836bf1 100static const uint64_t samplerates[] = {
79dc6498
JH
101 SR_KHZ(20),
102 SR_KHZ(25),
897c1a2e
JH
103 SR_KHZ(50),
104 SR_KHZ(100),
9304d576
JH
105 SR_KHZ(200),
106 SR_KHZ(250),
107 SR_KHZ(500),
8b35f474
JH
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),
772a0e61 116 SR_MHZ(24),
8b35f474
JH
117};
118
a8cc8e44 119SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
a873c594 120static struct sr_dev_driver *di = &fx2lafw_driver_info;
25a0f108 121static int hw_dev_close(struct sr_dev_inst *sdi);
69b07d14 122static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
610dbb70 123
b1eeb67e
JH
124/**
125 * Check the USB configuration to determine if this is an fx2lafw device.
126 *
f9a69557
UH
127 * @return TRUE if the device's configuration profile match fx2lafw
128 * configuration, FALSE otherwise.
b1eeb67e 129 */
f9a69557 130static gboolean check_conf_profile(libusb_device *dev)
b1eeb67e
JH
131{
132 struct libusb_device_descriptor des;
6b73d9a5
BV
133 struct libusb_device_handle *hdl;
134 gboolean ret;
135 unsigned char strdesc[64];
b1eeb67e 136
6b73d9a5
BV
137 hdl = NULL;
138 ret = FALSE;
b1eeb67e 139 while (!ret) {
da686568 140 /* Assume the FW has not been loaded, unless proven wrong. */
b1eeb67e
JH
141 if (libusb_get_device_descriptor(dev, &des) != 0)
142 break;
143
6b73d9a5 144 if (libusb_open(dev, &hdl) != 0)
b1eeb67e
JH
145 break;
146
6b73d9a5 147 if (libusb_get_string_descriptor_ascii(hdl,
b99457f0 148 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
b1eeb67e 149 break;
6b73d9a5 150 if (strncmp((const char *)strdesc, "sigrok", 6))
b1eeb67e
JH
151 break;
152
6b73d9a5
BV
153 if (libusb_get_string_descriptor_ascii(hdl,
154 des.iProduct, strdesc, sizeof(strdesc)) < 0)
b1eeb67e 155 break;
6b73d9a5 156 if (strncmp((const char *)strdesc, "fx2lafw", 7))
b1eeb67e
JH
157 break;
158
b1eeb67e 159 /* If we made it here, it must be an fx2lafw. */
f9a69557 160 ret = TRUE;
b1eeb67e 161 }
6b73d9a5
BV
162 if (hdl)
163 libusb_close(hdl);
b1eeb67e
JH
164
165 return ret;
166}
167
25a0f108 168static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
43125c69
JH
169{
170 libusb_device **devlist;
171 struct libusb_device_descriptor des;
dc9dbe94 172 struct dev_context *devc;
b99457f0 173 struct drv_context *drvc;
13bf7ecc 174 struct version_info vi;
b99457f0 175 int ret, skip, i, device_count;
1e94408a 176 uint8_t revid;
43125c69 177
b99457f0 178 drvc = di->priv;
dc9dbe94 179 devc = sdi->priv;
43125c69
JH
180
181 if (sdi->status == SR_ST_ACTIVE)
b99457f0 182 /* Device is already in use. */
43125c69
JH
183 return SR_ERR;
184
185 skip = 0;
b99457f0 186 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
6fbe5e60 187 if (device_count < 0) {
b99457f0
UH
188 sr_err("Failed to get device list: %s.",
189 libusb_error_name(device_count));
6fbe5e60
JH
190 return SR_ERR;
191 }
192
193 for (i = 0; i < device_count; i++) {
ebc34738 194 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
f427daef 195 sr_err("Failed to get device descriptor: %s.",
d4928d71 196 libusb_error_name(ret));
43125c69
JH
197 continue;
198 }
199
dc9dbe94
BV
200 if (des.idVendor != devc->profile->vid
201 || des.idProduct != devc->profile->pid)
43125c69
JH
202 continue;
203
204 if (sdi->status == SR_ST_INITIALIZING) {
25a0f108 205 if (skip != sdi->index) {
43125c69
JH
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 */
dc9dbe94
BV
215 if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
216 || libusb_get_device_address(devlist[i]) != devc->usb->address)
b99457f0 217 /* This is not the one. */
43125c69
JH
218 continue;
219 }
220
dc9dbe94
BV
221 if (!(ret = libusb_open(devlist[i], &devc->usb->devhdl))) {
222 if (devc->usb->address == 0xff)
43125c69 223 /*
b99457f0
UH
224 * First time we touch this device after FW
225 * upload, so we don't know the address yet.
43125c69 226 */
dc9dbe94 227 devc->usb->address = libusb_get_device_address(devlist[i]);
43125c69 228 } else {
f427daef 229 sr_err("Failed to open device: %s.",
d4928d71 230 libusb_error_name(ret));
13bf7ecc
JH
231 break;
232 }
233
dc9dbe94 234 ret = command_get_fw_version(devc->usb->devhdl, &vi);
44dfd483 235 if (ret != SR_OK) {
b99457f0 236 sr_err("Failed to get firmware version.");
13bf7ecc 237 break;
43125c69
JH
238 }
239
dc9dbe94 240 ret = command_get_revid_version(devc->usb->devhdl, &revid);
1e94408a 241 if (ret != SR_OK) {
b99457f0 242 sr_err("Failed to get REVID.");
1e94408a
UH
243 break;
244 }
245
0a8c0c32
UH
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) {
f427daef 252 sr_err("Expected firmware version %d.x, "
0a8c0c32
UH
253 "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
254 vi.major, vi.minor);
13bf7ecc
JH
255 break;
256 }
257
258 sdi->status = SR_ST_ACTIVE;
b99457f0 259 sr_info("Opened device %d on %d.%d, "
cbc80f8f 260 "interface %d, firmware %d.%d.",
dc9dbe94 261 sdi->index, devc->usb->bus, devc->usb->address,
cbc80f8f
AG
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)");
13bf7ecc 266
43125c69
JH
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
014359e3 277static int configure_probes(const struct sr_dev_inst *sdi)
6c6781b6 278{
014359e3 279 struct dev_context *devc;
6c6781b6
JH
280 struct sr_probe *probe;
281 GSList *l;
282 int probe_bit, stage, i;
283 char *tc;
284
014359e3 285 devc = sdi->priv;
6c6781b6 286 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
dc9dbe94
BV
287 devc->trigger_mask[i] = 0;
288 devc->trigger_value[i] = 0;
6c6781b6
JH
289 }
290
291 stage = -1;
014359e3 292 for (l = sdi->probes; l; l = l->next) {
6c6781b6
JH
293 probe = (struct sr_probe *)l->data;
294 if (probe->enabled == FALSE)
295 continue;
d1ddc7a9 296
b35c8293 297 if (probe->index > 7)
dc9dbe94 298 devc->sample_wide = TRUE;
d1ddc7a9 299
b35c8293 300 probe_bit = 1 << (probe->index);
6c6781b6
JH
301 if (!(probe->trigger))
302 continue;
303
304 stage = 0;
305 for (tc = probe->trigger; *tc; tc++) {
dc9dbe94 306 devc->trigger_mask[stage] |= probe_bit;
6c6781b6 307 if (*tc == '1')
dc9dbe94 308 devc->trigger_value[stage] |= probe_bit;
6c6781b6
JH
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 */
dc9dbe94 320 devc->trigger_stage = TRIGGER_FIRED;
6c6781b6 321 else
dc9dbe94 322 devc->trigger_stage = 0;
6c6781b6
JH
323
324 return SR_OK;
325}
326
dc9dbe94 327static struct dev_context *fx2lafw_dev_new(void)
187b3582 328{
dc9dbe94 329 struct dev_context *devc;
187b3582 330
dc9dbe94 331 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
b99457f0 332 sr_err("Device context malloc failed.");
187b3582
JH
333 return NULL;
334 }
335
dc9dbe94 336 devc->trigger_stage = TRIGGER_FIRED;
6c6781b6 337
dc9dbe94 338 return devc;
187b3582 339}
f302a082 340
f69b47f0
BV
341static int clear_instances(void)
342{
343 GSList *l;
344 struct sr_dev_inst *sdi;
dc9dbe94
BV
345 struct drv_context *drvc;
346 struct dev_context *devc;
f69b47f0
BV
347 int ret;
348
a873c594 349 drvc = di->priv;
f69b47f0 350 ret = SR_OK;
dc9dbe94 351 for (l = drvc->instances; l; l = l->next) {
f69b47f0
BV
352 if (!(sdi = l->data)) {
353 /* Log error, but continue cleaning up the rest. */
b99457f0 354 sr_err("sdi was NULL, continuing.");
f69b47f0
BV
355 ret = SR_ERR_BUG;
356 continue;
357 }
dc9dbe94 358 if (!(devc = sdi->priv)) {
f69b47f0 359 /* Log error, but continue cleaning up the rest. */
b99457f0 360 sr_err("sdi->priv was NULL, continuing.");
f69b47f0
BV
361 ret = SR_ERR_BUG;
362 continue;
363 }
25a0f108 364 hw_dev_close(sdi);
fabe59b3 365 sr_usb_dev_inst_free(devc->usb);
f69b47f0
BV
366 sdi = l->data;
367 sr_dev_inst_free(sdi);
368 }
369
dc9dbe94
BV
370 g_slist_free(drvc->instances);
371 drvc->instances = NULL;
f69b47f0
BV
372
373 return ret;
374}
375
34f06b90 376static int hw_init(struct sr_context *sr_ctx)
61136ea6 377{
063e7aef 378 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
61136ea6
BV
379}
380
3a7a22cb 381static GSList *hw_scan(GSList *options)
f302a082 382{
dc9dbe94
BV
383 struct drv_context *drvc;
384 struct dev_context *devc;
754b5ff2
BV
385 struct sr_dev_inst *sdi;
386 struct sr_usb_dev_inst *usb;
3a7a22cb 387 struct sr_probe *probe;
754b5ff2
BV
388 struct sr_config *src;
389 const struct fx2lafw_profile *prof;
390 GSList *l, *devices, *conn_devices;
391 struct libusb_device_descriptor des;
187b3582 392 libusb_device **devlist;
3a7a22cb 393 int devcnt, num_logic_probes, ret, i, j;
754b5ff2 394 const char *conn;
3a7a22cb 395
3a7a22cb 396 (void)options;
64d33dc2 397
a873c594 398 drvc = di->priv;
187b3582 399
f69b47f0
BV
400 /* This scan always invalidates any previous scans. */
401 clear_instances();
402
754b5ff2
BV
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
921634ec 417 /* Find all fx2lafw compatible devices and upload firmware to them. */
3a7a22cb 418 devices = NULL;
d4abb463 419 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
187b3582 420 for (i = 0; devlist[i]; i++) {
754b5ff2
BV
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 }
187b3582 434
754b5ff2 435 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
f427daef 436 sr_warn("Failed to get device descriptor: %s.",
d4928d71 437 libusb_error_name(ret));
187b3582
JH
438 continue;
439 }
440
da686568 441 prof = NULL;
187b3582
JH
442 for (j = 0; supported_fx2[j].vid; j++) {
443 if (des.idVendor == supported_fx2[j].vid &&
444 des.idProduct == supported_fx2[j].pid) {
da686568 445 prof = &supported_fx2[j];
187b3582
JH
446 }
447 }
448
b99457f0 449 /* Skip if the device was not found. */
da686568 450 if (!prof)
187b3582
JH
451 continue;
452
dc9dbe94 453 devcnt = g_slist_length(drvc->instances);
187b3582 454 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
da686568 455 prof->vendor, prof->model, prof->model_version);
f4a9e5c0 456 if (!sdi)
25a0f108 457 return NULL;
a873c594 458 sdi->driver = di;
187b3582 459
06717a8a
BV
460 /* Fill in probelist according to this device's profile. */
461 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
c5e82ca5 462 for (j = 0; j < num_logic_probes; j++) {
06717a8a
BV
463 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
464 probe_names[j])))
25a0f108 465 return NULL;
06717a8a
BV
466 sdi->probes = g_slist_append(sdi->probes, probe);
467 }
468
dc9dbe94
BV
469 devc = fx2lafw_dev_new();
470 devc->profile = prof;
471 sdi->priv = devc;
472 drvc->instances = g_slist_append(drvc->instances, sdi);
a8cc8e44 473 devices = g_slist_append(devices, sdi);
187b3582 474
b1eeb67e
JH
475 if (check_conf_profile(devlist[i])) {
476 /* Already has the firmware, so fix the new address. */
f427daef 477 sr_dbg("Found an fx2lafw device.");
b1eeb67e 478 sdi->status = SR_ST_INACTIVE;
dc9dbe94 479 devc->usb = sr_usb_dev_inst_new
b1eeb67e
JH
480 (libusb_get_bus_number(devlist[i]),
481 libusb_get_device_address(devlist[i]), NULL);
482 } else {
f8b07fc6 483 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
da686568 484 prof->firmware) == SR_OK)
b99457f0 485 /* Store when this device's FW was updated. */
dc9dbe94 486 devc->fw_updated = g_get_monotonic_time();
b1eeb67e 487 else
f427daef 488 sr_err("Firmware upload failed for "
7ae2f9d5 489 "device %d.", devcnt);
dc9dbe94 490 devc->usb = sr_usb_dev_inst_new
b1eeb67e
JH
491 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
492 }
187b3582
JH
493 }
494 libusb_free_device_list(devlist, 1);
495
3a7a22cb 496 return devices;
f302a082
JH
497}
498
811deee4
BV
499static GSList *hw_dev_list(void)
500{
0e94d524 501 return ((struct drv_context *)(di->priv))->instances;
811deee4
BV
502}
503
25a0f108 504static int hw_dev_open(struct sr_dev_inst *sdi)
f302a082 505{
dc9dbe94 506 struct dev_context *devc;
e8bd58ff
UH
507 int ret;
508 int64_t timediff_us, timediff_ms;
43125c69 509
dc9dbe94 510 devc = sdi->priv;
43125c69
JH
511
512 /*
f60fdf6e
UH
513 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
514 * milliseconds for the FX2 to renumerate.
43125c69 515 */
3b6c1930 516 ret = SR_ERR;
dc9dbe94 517 if (devc->fw_updated > 0) {
f427daef 518 sr_info("Waiting for device to reset.");
b99457f0 519 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
43125c69 520 g_usleep(300 * 1000);
e8bd58ff 521 timediff_ms = 0;
f60fdf6e 522 while (timediff_ms < MAX_RENUM_DELAY_MS) {
25a0f108 523 if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
43125c69
JH
524 break;
525 g_usleep(100 * 1000);
e8bd58ff 526
dc9dbe94 527 timediff_us = g_get_monotonic_time() - devc->fw_updated;
3b6c1930 528 timediff_ms = timediff_us / 1000;
b99457f0 529 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
43125c69 530 }
443a14d8
AG
531 if (ret != SR_OK) {
532 sr_err("Device failed to renumerate.");
533 return SR_ERR;
534 }
c0bf69c2 535 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
43125c69 536 } else {
443a14d8 537 sr_info("Firmware upload was not needed.");
25a0f108 538 ret = fx2lafw_dev_open(sdi);
43125c69
JH
539 }
540
ebc34738 541 if (ret != SR_OK) {
f427daef 542 sr_err("Unable to open device.");
43125c69
JH
543 return SR_ERR;
544 }
378abfea 545
dc9dbe94 546 devc = sdi->priv;
43125c69 547
dc9dbe94 548 ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
ebc34738 549 if (ret != 0) {
0c156e06
JH
550 switch(ret) {
551 case LIBUSB_ERROR_BUSY:
f427daef 552 sr_err("Unable to claim USB interface. Another "
b99457f0 553 "program or driver has already claimed it.");
0c156e06 554 break;
0c156e06 555 case LIBUSB_ERROR_NO_DEVICE:
f427daef 556 sr_err("Device has been disconnected.");
0c156e06 557 break;
0c156e06 558 default:
f427daef 559 sr_err("Unable to claim interface: %s.",
d4928d71 560 libusb_error_name(ret));
0c156e06
JH
561 break;
562 }
563
43125c69
JH
564 return SR_ERR;
565 }
566
dc9dbe94 567 if (devc->cur_samplerate == 0) {
f92994fd 568 /* Samplerate hasn't been set; default to the slowest one. */
d6836bf1 569 devc->cur_samplerate = samplerates[0];
f92994fd
JH
570 }
571
f302a082
JH
572 return SR_OK;
573}
574
25a0f108 575static int hw_dev_close(struct sr_dev_inst *sdi)
f302a082 576{
dc9dbe94 577 struct dev_context *devc;
f1898235 578
dc9dbe94 579 devc = sdi->priv;
961009b0 580
dc9dbe94 581 if (devc->usb->devhdl == NULL)
25a0f108 582 return SR_ERR;
f1898235 583
b99457f0 584 sr_info("Closing device %d on %d.%d, interface %d.",
dc9dbe94
BV
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;
25a0f108 589 sdi->status = SR_ST_INACTIVE;
f1898235 590
f302a082
JH
591 return SR_OK;
592}
593
594static int hw_cleanup(void)
595{
dc9dbe94 596 struct drv_context *drvc;
f69b47f0 597 int ret;
187b3582 598
a873c594 599 if (!(drvc = di->priv))
dc9dbe94
BV
600 return SR_OK;
601
f69b47f0 602 ret = clear_instances();
187b3582 603
dc9dbe94 604 g_free(drvc);
a873c594 605 di->priv = NULL;
187b3582 606
62bc70e4 607 return ret;
f302a082
JH
608}
609
d6836bf1 610static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
f302a082 611{
dc9dbe94 612 struct dev_context *devc;
8b35f474 613
035a1078 614 switch (id) {
123e1313 615 case SR_CONF_SAMPLERATE:
6e9339aa 616 if (sdi) {
dc9dbe94 617 devc = sdi->priv;
d6836bf1 618 *data = g_variant_new_uint64(devc->cur_samplerate);
6e9339aa
BV
619 } else
620 return SR_ERR;
621 break;
622 default:
bd6fbf62 623 return SR_ERR_NA;
8b35f474
JH
624 }
625
6e9339aa 626 return SR_OK;
f302a082
JH
627}
628
d6836bf1 629static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
f302a082 630{
dc9dbe94 631 struct dev_context *devc;
7cb621d4
JH
632 int ret;
633
dc9dbe94 634 devc = sdi->priv;
7cb621d4 635
035a1078 636 if (id == SR_CONF_SAMPLERATE) {
d6836bf1 637 devc->cur_samplerate = g_variant_get_uint64(data);
e3186647 638 ret = SR_OK;
035a1078 639 } else if (id == SR_CONF_LIMIT_SAMPLES) {
d6836bf1 640 devc->limit_samples = g_variant_get_uint64(data);
7cb621d4
JH
641 ret = SR_OK;
642 } else {
bd6fbf62 643 ret = SR_ERR_NA;
7cb621d4
JH
644 }
645
646 return ret;
f302a082
JH
647}
648
d6836bf1 649static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
a1c743fc 650{
d6836bf1
BV
651 GVariant *gvar;
652 GVariantBuilder gvb;
a1c743fc
BV
653
654 (void)sdi;
655
656 switch (key) {
9a6517d1 657 case SR_CONF_DEVICE_OPTIONS:
d6836bf1
BV
658 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
659 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1 660 break;
a1c743fc 661 case SR_CONF_SAMPLERATE:
d6836bf1
BV
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);
a1c743fc 667 break;
c50277a6 668 case SR_CONF_TRIGGER_TYPE:
d6836bf1 669 *data = g_variant_new_string(TRIGGER_TYPE);
c50277a6 670 break;
a1c743fc 671 default:
bd6fbf62 672 return SR_ERR_NA;
a1c743fc
BV
673 }
674
675 return SR_OK;
676}
677
1f9813eb 678static int receive_data(int fd, int revents, void *cb_data)
610dbb70
JH
679{
680 struct timeval tv;
b99457f0 681 struct drv_context *drvc;
610dbb70 682
610dbb70
JH
683 (void)fd;
684 (void)revents;
1f9813eb 685 (void)cb_data;
610dbb70 686
b99457f0
UH
687 drvc = di->priv;
688
610dbb70 689 tv.tv_sec = tv.tv_usec = 0;
d4abb463 690 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
610dbb70
JH
691
692 return TRUE;
693}
694
dc9dbe94 695static void abort_acquisition(struct dev_context *devc)
cb61e9f7 696{
e7d087bf 697 int i;
0caa1ef0 698
dc9dbe94 699 devc->num_samples = -1;
0caa1ef0 700
dc9dbe94
BV
701 for (i = devc->num_transfers - 1; i >= 0; i--) {
702 if (devc->transfers[i])
703 libusb_cancel_transfer(devc->transfers[i]);
0caa1ef0 704 }
cb61e9f7
JH
705}
706
dc9dbe94 707static void finish_acquisition(struct dev_context *devc)
2e526f4a
JH
708{
709 struct sr_datafeed_packet packet;
a873c594 710 struct drv_context *drvc = di->priv;
b99457f0 711 const struct libusb_pollfd **lupfd;
cb61e9f7 712 int i;
2e526f4a 713
b99457f0 714 /* Terminate session. */
2e526f4a 715 packet.type = SR_DF_END;
3e9b7f9c 716 sr_session_send(devc->cb_data, &packet);
2e526f4a 717
b99457f0
UH
718 /* Remove fds from polling. */
719 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
cb61e9f7
JH
720 for (i = 0; lupfd[i]; i++)
721 sr_source_remove(lupfd[i]->fd);
722 free(lupfd); /* NOT g_free()! */
0caa1ef0 723
dc9dbe94
BV
724 devc->num_transfers = 0;
725 g_free(devc->transfers);
2e526f4a
JH
726}
727
f855de75
LPC
728static void free_transfer(struct libusb_transfer *transfer)
729{
b99457f0 730 struct dev_context *devc;
0caa1ef0 731 unsigned int i;
f855de75 732
b99457f0
UH
733 devc = transfer->user_data;
734
f855de75
LPC
735 g_free(transfer->buffer);
736 transfer->buffer = NULL;
737 libusb_free_transfer(transfer);
738
dc9dbe94
BV
739 for (i = 0; i < devc->num_transfers; i++) {
740 if (devc->transfers[i] == transfer) {
741 devc->transfers[i] = NULL;
0caa1ef0
LPC
742 break;
743 }
744 }
745
dc9dbe94
BV
746 devc->submitted_transfers--;
747 if (devc->submitted_transfers == 0)
748 finish_acquisition(devc);
f855de75
LPC
749}
750
17dff8a1
LPC
751static void resubmit_transfer(struct libusb_transfer *transfer)
752{
b99457f0 753 int ret;
d4928d71 754
b99457f0 755 if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
d4928d71
PS
756 return;
757
758 free_transfer(transfer);
759 /* TODO: Stop session? */
760
f427daef 761 sr_err("%s: %s", __func__, libusb_error_name(ret));
17dff8a1
LPC
762}
763
610dbb70
JH
764static void receive_transfer(struct libusb_transfer *transfer)
765{
7ce737a7 766 gboolean packet_has_error = FALSE;
610dbb70
JH
767 struct sr_datafeed_packet packet;
768 struct sr_datafeed_logic logic;
b99457f0
UH
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;
610dbb70 775
610dbb70
JH
776 /*
777 * If acquisition has already ended, just free any queued up
778 * transfer that come in.
779 */
dc9dbe94 780 if (devc->num_samples == -1) {
f855de75 781 free_transfer(transfer);
610dbb70
JH
782 return;
783 }
784
f427daef 785 sr_info("receive_transfer(): status %d received %d bytes.",
610dbb70
JH
786 transfer->status, transfer->actual_length);
787
788 /* Save incoming transfer before reusing the transfer struct. */
b99457f0
UH
789 cur_buf = transfer->buffer;
790 sample_width = devc->sample_wide ? 2 : 1;
791 cur_sample_count = transfer->actual_length / sample_width;
610dbb70 792
7ce737a7
LPC
793 switch (transfer->status) {
794 case LIBUSB_TRANSFER_NO_DEVICE:
dc9dbe94 795 abort_acquisition(devc);
7ce737a7
LPC
796 free_transfer(transfer);
797 return;
798 case LIBUSB_TRANSFER_COMPLETED:
b99457f0 799 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
7ce737a7
LPC
800 break;
801 default:
802 packet_has_error = TRUE;
803 break;
804 }
805
806 if (transfer->actual_length == 0 || packet_has_error) {
dc9dbe94
BV
807 devc->empty_transfer_count++;
808 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
610dbb70
JH
809 /*
810 * The FX2 gave up. End the acquisition, the frontend
811 * will work out that the samplecount is short.
812 */
dc9dbe94 813 abort_acquisition(devc);
17dff8a1
LPC
814 free_transfer(transfer);
815 } else {
816 resubmit_transfer(transfer);
610dbb70
JH
817 }
818 return;
819 } else {
dc9dbe94 820 devc->empty_transfer_count = 0;
610dbb70
JH
821 }
822
6c6781b6 823 trigger_offset = 0;
dc9dbe94 824 if (devc->trigger_stage >= 0) {
d1ddc7a9
JH
825 for (i = 0; i < cur_sample_count; i++) {
826
dc9dbe94 827 const uint16_t cur_sample = devc->sample_wide ?
d1ddc7a9
JH
828 *((const uint16_t*)cur_buf + i) :
829 *((const uint8_t*)cur_buf + i);
6c6781b6 830
dc9dbe94
BV
831 if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) ==
832 devc->trigger_value[devc->trigger_stage]) {
6c6781b6 833 /* Match on this trigger stage. */
dc9dbe94
BV
834 devc->trigger_buffer[devc->trigger_stage] = cur_sample;
835 devc->trigger_stage++;
6c6781b6 836
dc9dbe94
BV
837 if (devc->trigger_stage == NUM_TRIGGER_STAGES ||
838 devc->trigger_mask[devc->trigger_stage] == 0) {
6c6781b6
JH
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;
3e9b7f9c 848 sr_session_send(devc->cb_data, &packet);
6c6781b6
JH
849
850 /*
b99457f0
UH
851 * Send the samples that triggered it,
852 * since we're skipping past them.
6c6781b6
JH
853 */
854 packet.type = SR_DF_LOGIC;
855 packet.payload = &logic;
dc9dbe94
BV
856 logic.unitsize = sizeof(*devc->trigger_buffer);
857 logic.length = devc->trigger_stage * logic.unitsize;
858 logic.data = devc->trigger_buffer;
3e9b7f9c 859 sr_session_send(devc->cb_data, &packet);
6c6781b6 860
dc9dbe94 861 devc->trigger_stage = TRIGGER_FIRED;
6c6781b6
JH
862 break;
863 }
dc9dbe94 864 } else if (devc->trigger_stage > 0) {
f3ab43a8
LPC
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 */
dc9dbe94 872 i -= devc->trigger_stage;
6c6781b6
JH
873 if (i < -1)
874 i = -1; /* Oops, went back past this buffer. */
875 /* Reset trigger stage. */
dc9dbe94 876 devc->trigger_stage = 0;
6c6781b6
JH
877 }
878 }
879 }
610dbb70 880
dc9dbe94 881 if (devc->trigger_stage == TRIGGER_FIRED) {
6c6781b6 882 /* Send the incoming transfer to the session bus. */
b99457f0 883 trigger_offset_bytes = trigger_offset * sample_width;
6c6781b6
JH
884 packet.type = SR_DF_LOGIC;
885 packet.payload = &logic;
d1ddc7a9
JH
886 logic.length = transfer->actual_length - trigger_offset_bytes;
887 logic.unitsize = sample_width;
888 logic.data = cur_buf + trigger_offset_bytes;
3e9b7f9c 889 sr_session_send(devc->cb_data, &packet);
6c6781b6 890
dc9dbe94
BV
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);
0caa1ef0
LPC
895 free_transfer(transfer);
896 return;
6c6781b6
JH
897 }
898 } else {
899 /*
900 * TODO: Buffer pre-trigger data in capture
901 * ratio-sized buffer.
902 */
610dbb70 903 }
17dff8a1
LPC
904
905 resubmit_transfer(transfer);
610dbb70
JH
906}
907
5af666a9
LPC
908static unsigned int to_bytes_per_ms(unsigned int samplerate)
909{
910 return samplerate / 1000;
911}
912
dc9dbe94 913static size_t get_buffer_size(struct dev_context *devc)
5af666a9
LPC
914{
915 size_t s;
916
b99457f0
UH
917 /*
918 * The buffer should be large enough to hold 10ms of data and
919 * a multiple of 512.
920 */
dc9dbe94 921 s = 10 * to_bytes_per_ms(devc->cur_samplerate);
5af666a9
LPC
922 return (s + 511) & ~511;
923}
924
dc9dbe94 925static unsigned int get_number_of_transfers(struct dev_context *devc)
5af666a9
LPC
926{
927 unsigned int n;
928
b99457f0 929 /* Total buffer size should be able to hold about 500ms of data. */
dc9dbe94 930 n = 500 * to_bytes_per_ms(devc->cur_samplerate) / get_buffer_size(devc);
5af666a9
LPC
931
932 if (n > NUM_SIMUL_TRANSFERS)
933 return NUM_SIMUL_TRANSFERS;
934
935 return n;
936}
937
dc9dbe94 938static unsigned int get_timeout(struct dev_context *devc)
5af666a9
LPC
939{
940 size_t total_size;
941 unsigned int timeout;
942
dc9dbe94
BV
943 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
944 timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
b99457f0 945 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
5af666a9
LPC
946}
947
3ffb6964
BV
948static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
949 void *cb_data)
f302a082 950{
dc9dbe94 951 struct dev_context *devc;
b99457f0 952 struct drv_context *drvc;
610dbb70
JH
953 struct libusb_transfer *transfer;
954 const struct libusb_pollfd **lupfd;
b99457f0 955 unsigned int i, timeout, num_transfers;
5af666a9 956 int ret;
610dbb70 957 unsigned char *buf;
b99457f0 958 size_t size;
610dbb70 959
b99457f0 960 drvc = di->priv;
dc9dbe94 961 devc = sdi->priv;
b99457f0 962
dc9dbe94 963 if (devc->submitted_transfers != 0)
c03f0450
LPC
964 return SR_ERR;
965
014359e3 966 if (configure_probes(sdi) != SR_OK) {
b99457f0 967 sr_err("Failed to configure probes.");
014359e3
BV
968 return SR_ERR;
969 }
970
3e9b7f9c 971 devc->cb_data = cb_data;
dc9dbe94
BV
972 devc->num_samples = 0;
973 devc->empty_transfer_count = 0;
610dbb70 974
b99457f0
UH
975 timeout = get_timeout(devc);
976 num_transfers = get_number_of_transfers(devc);
977 size = get_buffer_size(devc);
5af666a9 978
dc9dbe94 979 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
886a52b6 980 if (!devc->transfers) {
f427daef 981 sr_err("USB transfers malloc failed.");
886a52b6
UH
982 return SR_ERR_MALLOC;
983 }
0caa1ef0 984
dc9dbe94 985 devc->num_transfers = num_transfers;
0caa1ef0 986
5af666a9 987 for (i = 0; i < num_transfers; i++) {
610dbb70 988 if (!(buf = g_try_malloc(size))) {
b99457f0 989 sr_err("USB transfer buffer malloc failed.");
610dbb70
JH
990 return SR_ERR_MALLOC;
991 }
992 transfer = libusb_alloc_transfer(0);
dc9dbe94 993 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
610dbb70 994 2 | LIBUSB_ENDPOINT_IN, buf, size,
dc9dbe94 995 receive_transfer, devc, timeout);
d4928d71 996 if ((ret = libusb_submit_transfer(transfer)) != 0) {
b99457f0
UH
997 sr_err("Failed to submit transfer: %s.",
998 libusb_error_name(ret));
610dbb70
JH
999 libusb_free_transfer(transfer);
1000 g_free(buf);
dc9dbe94 1001 abort_acquisition(devc);
610dbb70
JH
1002 return SR_ERR;
1003 }
dc9dbe94
BV
1004 devc->transfers[i] = transfer;
1005 devc->submitted_transfers++;
610dbb70
JH
1006 }
1007
d4abb463 1008 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
610dbb70
JH
1009 for (i = 0; lupfd[i]; i++)
1010 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
5af666a9 1011 timeout, receive_data, NULL);
610dbb70
JH
1012 free(lupfd); /* NOT g_free()! */
1013
4afdfd46
UH
1014 /* Send header packet to the session bus. */
1015 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
f366e86c 1016
b99457f0 1017 if ((ret = command_start_acquisition(devc->usb->devhdl,
dc9dbe94
BV
1018 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1019 abort_acquisition(devc);
ebc34738 1020 return ret;
017375d1
JH
1021 }
1022
f302a082
JH
1023 return SR_OK;
1024}
1025
3cd3a20b 1026/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
69b07d14 1027static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
f302a082 1028{
2e526f4a 1029 (void)cb_data;
5da93902 1030
2e526f4a 1031 abort_acquisition(sdi->priv);
5da93902 1032
f302a082
JH
1033 return SR_OK;
1034}
1035
c09f0b57 1036SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
f302a082 1037 .name = "fx2lafw",
2e7cb004 1038 .longname = "fx2lafw (generic driver for FX2 based LAs)",
f302a082
JH
1039 .api_version = 1,
1040 .init = hw_init,
1041 .cleanup = hw_cleanup,
61136ea6 1042 .scan = hw_scan,
811deee4
BV
1043 .dev_list = hw_dev_list,
1044 .dev_clear = clear_instances,
035a1078
BV
1045 .config_get = config_get,
1046 .config_set = config_set,
a1c743fc 1047 .config_list = config_list,
f302a082
JH
1048 .dev_open = hw_dev_open,
1049 .dev_close = hw_dev_close,
f302a082
JH
1050 .dev_acquisition_start = hw_dev_acquisition_start,
1051 .dev_acquisition_stop = hw_dev_acquisition_stop,
dc9dbe94 1052 .priv = NULL,
f302a082 1053};