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