]> sigrok.org Git - libsigrok.git/blame - hardware/fx2lafw/fx2lafw.c
ols: Code cleanup
[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);
470
3a7a22cb 471 return devices;
f302a082
JH
472}
473
811deee4
BV
474static GSList *hw_dev_list(void)
475{
0e94d524 476 return ((struct drv_context *)(di->priv))->instances;
811deee4
BV
477}
478
25a0f108 479static int hw_dev_open(struct sr_dev_inst *sdi)
f302a082 480{
250a78c7 481 struct sr_usb_dev_inst *usb;
dc9dbe94 482 struct dev_context *devc;
e8bd58ff
UH
483 int ret;
484 int64_t timediff_us, timediff_ms;
43125c69 485
dc9dbe94 486 devc = sdi->priv;
250a78c7 487 usb = sdi->conn;
43125c69
JH
488
489 /*
f60fdf6e
UH
490 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
491 * milliseconds for the FX2 to renumerate.
43125c69 492 */
3b6c1930 493 ret = SR_ERR;
dc9dbe94 494 if (devc->fw_updated > 0) {
f427daef 495 sr_info("Waiting for device to reset.");
b99457f0 496 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
43125c69 497 g_usleep(300 * 1000);
e8bd58ff 498 timediff_ms = 0;
f60fdf6e 499 while (timediff_ms < MAX_RENUM_DELAY_MS) {
25a0f108 500 if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
43125c69
JH
501 break;
502 g_usleep(100 * 1000);
e8bd58ff 503
dc9dbe94 504 timediff_us = g_get_monotonic_time() - devc->fw_updated;
3b6c1930 505 timediff_ms = timediff_us / 1000;
b99457f0 506 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
43125c69 507 }
443a14d8
AG
508 if (ret != SR_OK) {
509 sr_err("Device failed to renumerate.");
510 return SR_ERR;
511 }
c0bf69c2 512 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
43125c69 513 } else {
443a14d8 514 sr_info("Firmware upload was not needed.");
25a0f108 515 ret = fx2lafw_dev_open(sdi);
43125c69
JH
516 }
517
ebc34738 518 if (ret != SR_OK) {
f427daef 519 sr_err("Unable to open device.");
43125c69
JH
520 return SR_ERR;
521 }
378abfea 522
250a78c7 523 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
ebc34738 524 if (ret != 0) {
0c156e06
JH
525 switch(ret) {
526 case LIBUSB_ERROR_BUSY:
f427daef 527 sr_err("Unable to claim USB interface. Another "
b99457f0 528 "program or driver has already claimed it.");
0c156e06 529 break;
0c156e06 530 case LIBUSB_ERROR_NO_DEVICE:
f427daef 531 sr_err("Device has been disconnected.");
0c156e06 532 break;
0c156e06 533 default:
f427daef 534 sr_err("Unable to claim interface: %s.",
d4928d71 535 libusb_error_name(ret));
0c156e06
JH
536 break;
537 }
538
43125c69
JH
539 return SR_ERR;
540 }
541
dc9dbe94 542 if (devc->cur_samplerate == 0) {
f92994fd 543 /* Samplerate hasn't been set; default to the slowest one. */
d6836bf1 544 devc->cur_samplerate = samplerates[0];
f92994fd
JH
545 }
546
f302a082
JH
547 return SR_OK;
548}
549
25a0f108 550static int hw_dev_close(struct sr_dev_inst *sdi)
f302a082 551{
250a78c7 552 struct sr_usb_dev_inst *usb;
961009b0 553
250a78c7
BV
554 usb = sdi->conn;
555 if (usb->devhdl == NULL)
25a0f108 556 return SR_ERR;
f1898235 557
250a78c7
BV
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;
25a0f108 563 sdi->status = SR_ST_INACTIVE;
f1898235 564
f302a082
JH
565 return SR_OK;
566}
567
568static int hw_cleanup(void)
569{
dc9dbe94 570 struct drv_context *drvc;
f69b47f0 571 int ret;
187b3582 572
a873c594 573 if (!(drvc = di->priv))
dc9dbe94
BV
574 return SR_OK;
575
f69b47f0 576 ret = clear_instances();
187b3582 577
dc9dbe94 578 g_free(drvc);
a873c594 579 di->priv = NULL;
187b3582 580
62bc70e4 581 return ret;
f302a082
JH
582}
583
d6836bf1 584static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
f302a082 585{
dc9dbe94 586 struct dev_context *devc;
89befd46
BV
587 struct sr_usb_dev_inst *usb;
588 char str[128];
8b35f474 589
035a1078 590 switch (id) {
89befd46
BV
591 case SR_CONF_CONN:
592 if (!sdi || !sdi->conn)
38ab8dbe 593 return SR_ERR_ARG;
89befd46
BV
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;
123e1313 602 case SR_CONF_SAMPLERATE:
89befd46 603 if (!sdi)
6e9339aa 604 return SR_ERR;
89befd46
BV
605 devc = sdi->priv;
606 *data = g_variant_new_uint64(devc->cur_samplerate);
6e9339aa
BV
607 break;
608 default:
bd6fbf62 609 return SR_ERR_NA;
8b35f474
JH
610 }
611
6e9339aa 612 return SR_OK;
f302a082
JH
613}
614
d6836bf1 615static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
f302a082 616{
dc9dbe94 617 struct dev_context *devc;
7cb621d4
JH
618 int ret;
619
e73ffd42
BV
620 if (sdi->status != SR_ST_ACTIVE)
621 return SR_ERR;
622
dc9dbe94 623 devc = sdi->priv;
7cb621d4 624
035a1078 625 if (id == SR_CONF_SAMPLERATE) {
d6836bf1 626 devc->cur_samplerate = g_variant_get_uint64(data);
e3186647 627 ret = SR_OK;
035a1078 628 } else if (id == SR_CONF_LIMIT_SAMPLES) {
d6836bf1 629 devc->limit_samples = g_variant_get_uint64(data);
7cb621d4
JH
630 ret = SR_OK;
631 } else {
bd6fbf62 632 ret = SR_ERR_NA;
7cb621d4
JH
633 }
634
635 return ret;
f302a082
JH
636}
637
d6836bf1 638static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
a1c743fc 639{
d6836bf1
BV
640 GVariant *gvar;
641 GVariantBuilder gvb;
a1c743fc
BV
642
643 (void)sdi;
644
645 switch (key) {
89befd46
BV
646 case SR_CONF_SCAN_OPTIONS:
647 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
648 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
649 break;
9a6517d1 650 case SR_CONF_DEVICE_OPTIONS:
d6836bf1
BV
651 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
652 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1 653 break;
a1c743fc 654 case SR_CONF_SAMPLERATE:
d6836bf1
BV
655 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
656 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
657 ARRAY_SIZE(samplerates), sizeof(uint64_t));
658 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
659 *data = g_variant_builder_end(&gvb);
a1c743fc 660 break;
c50277a6 661 case SR_CONF_TRIGGER_TYPE:
d6836bf1 662 *data = g_variant_new_string(TRIGGER_TYPE);
c50277a6 663 break;
a1c743fc 664 default:
bd6fbf62 665 return SR_ERR_NA;
a1c743fc
BV
666 }
667
668 return SR_OK;
669}
670
1f9813eb 671static int receive_data(int fd, int revents, void *cb_data)
610dbb70
JH
672{
673 struct timeval tv;
b99457f0 674 struct drv_context *drvc;
610dbb70 675
610dbb70
JH
676 (void)fd;
677 (void)revents;
1f9813eb 678 (void)cb_data;
610dbb70 679
b99457f0
UH
680 drvc = di->priv;
681
610dbb70 682 tv.tv_sec = tv.tv_usec = 0;
d4abb463 683 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
610dbb70
JH
684
685 return TRUE;
686}
687
dc9dbe94 688static void abort_acquisition(struct dev_context *devc)
cb61e9f7 689{
e7d087bf 690 int i;
0caa1ef0 691
dc9dbe94 692 devc->num_samples = -1;
0caa1ef0 693
dc9dbe94
BV
694 for (i = devc->num_transfers - 1; i >= 0; i--) {
695 if (devc->transfers[i])
696 libusb_cancel_transfer(devc->transfers[i]);
0caa1ef0 697 }
cb61e9f7
JH
698}
699
dc9dbe94 700static void finish_acquisition(struct dev_context *devc)
2e526f4a
JH
701{
702 struct sr_datafeed_packet packet;
cb61e9f7 703 int i;
2e526f4a 704
b99457f0 705 /* Terminate session. */
2e526f4a 706 packet.type = SR_DF_END;
3e9b7f9c 707 sr_session_send(devc->cb_data, &packet);
2e526f4a 708
b99457f0 709 /* Remove fds from polling. */
0a7da5f8
BV
710 for (i = 0; devc->usbfd[i] != -1; i++)
711 sr_source_remove(devc->usbfd[i]);
712 g_free(devc->usbfd);
0caa1ef0 713
dc9dbe94
BV
714 devc->num_transfers = 0;
715 g_free(devc->transfers);
2e526f4a
JH
716}
717
f855de75
LPC
718static void free_transfer(struct libusb_transfer *transfer)
719{
b99457f0 720 struct dev_context *devc;
0caa1ef0 721 unsigned int i;
f855de75 722
b99457f0
UH
723 devc = transfer->user_data;
724
f855de75
LPC
725 g_free(transfer->buffer);
726 transfer->buffer = NULL;
727 libusb_free_transfer(transfer);
728
dc9dbe94
BV
729 for (i = 0; i < devc->num_transfers; i++) {
730 if (devc->transfers[i] == transfer) {
731 devc->transfers[i] = NULL;
0caa1ef0
LPC
732 break;
733 }
734 }
735
dc9dbe94
BV
736 devc->submitted_transfers--;
737 if (devc->submitted_transfers == 0)
738 finish_acquisition(devc);
f855de75
LPC
739}
740
17dff8a1
LPC
741static void resubmit_transfer(struct libusb_transfer *transfer)
742{
b99457f0 743 int ret;
d4928d71 744
b99457f0 745 if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
d4928d71
PS
746 return;
747
748 free_transfer(transfer);
749 /* TODO: Stop session? */
750
f427daef 751 sr_err("%s: %s", __func__, libusb_error_name(ret));
17dff8a1
LPC
752}
753
610dbb70
JH
754static void receive_transfer(struct libusb_transfer *transfer)
755{
7ce737a7 756 gboolean packet_has_error = FALSE;
610dbb70
JH
757 struct sr_datafeed_packet packet;
758 struct sr_datafeed_logic logic;
b99457f0
UH
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;
610dbb70 765
610dbb70
JH
766 /*
767 * If acquisition has already ended, just free any queued up
768 * transfer that come in.
769 */
dc9dbe94 770 if (devc->num_samples == -1) {
f855de75 771 free_transfer(transfer);
610dbb70
JH
772 return;
773 }
774
f427daef 775 sr_info("receive_transfer(): status %d received %d bytes.",
610dbb70
JH
776 transfer->status, transfer->actual_length);
777
778 /* Save incoming transfer before reusing the transfer struct. */
b99457f0
UH
779 cur_buf = transfer->buffer;
780 sample_width = devc->sample_wide ? 2 : 1;
781 cur_sample_count = transfer->actual_length / sample_width;
610dbb70 782
7ce737a7
LPC
783 switch (transfer->status) {
784 case LIBUSB_TRANSFER_NO_DEVICE:
dc9dbe94 785 abort_acquisition(devc);
7ce737a7
LPC
786 free_transfer(transfer);
787 return;
788 case LIBUSB_TRANSFER_COMPLETED:
b99457f0 789 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
7ce737a7
LPC
790 break;
791 default:
792 packet_has_error = TRUE;
793 break;
794 }
795
796 if (transfer->actual_length == 0 || packet_has_error) {
dc9dbe94
BV
797 devc->empty_transfer_count++;
798 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
610dbb70
JH
799 /*
800 * The FX2 gave up. End the acquisition, the frontend
801 * will work out that the samplecount is short.
802 */
dc9dbe94 803 abort_acquisition(devc);
17dff8a1
LPC
804 free_transfer(transfer);
805 } else {
806 resubmit_transfer(transfer);
610dbb70
JH
807 }
808 return;
809 } else {
dc9dbe94 810 devc->empty_transfer_count = 0;
610dbb70
JH
811 }
812
6c6781b6 813 trigger_offset = 0;
dc9dbe94 814 if (devc->trigger_stage >= 0) {
d1ddc7a9
JH
815 for (i = 0; i < cur_sample_count; i++) {
816
dc9dbe94 817 const uint16_t cur_sample = devc->sample_wide ?
d1ddc7a9
JH
818 *((const uint16_t*)cur_buf + i) :
819 *((const uint8_t*)cur_buf + i);
6c6781b6 820
dc9dbe94
BV
821 if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) ==
822 devc->trigger_value[devc->trigger_stage]) {
6c6781b6 823 /* Match on this trigger stage. */
dc9dbe94
BV
824 devc->trigger_buffer[devc->trigger_stage] = cur_sample;
825 devc->trigger_stage++;
6c6781b6 826
dc9dbe94
BV
827 if (devc->trigger_stage == NUM_TRIGGER_STAGES ||
828 devc->trigger_mask[devc->trigger_stage] == 0) {
6c6781b6
JH
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;
3e9b7f9c 838 sr_session_send(devc->cb_data, &packet);
6c6781b6
JH
839
840 /*
b99457f0
UH
841 * Send the samples that triggered it,
842 * since we're skipping past them.
6c6781b6
JH
843 */
844 packet.type = SR_DF_LOGIC;
845 packet.payload = &logic;
dc9dbe94
BV
846 logic.unitsize = sizeof(*devc->trigger_buffer);
847 logic.length = devc->trigger_stage * logic.unitsize;
848 logic.data = devc->trigger_buffer;
3e9b7f9c 849 sr_session_send(devc->cb_data, &packet);
6c6781b6 850
dc9dbe94 851 devc->trigger_stage = TRIGGER_FIRED;
6c6781b6
JH
852 break;
853 }
dc9dbe94 854 } else if (devc->trigger_stage > 0) {
f3ab43a8
LPC
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 */
dc9dbe94 862 i -= devc->trigger_stage;
6c6781b6
JH
863 if (i < -1)
864 i = -1; /* Oops, went back past this buffer. */
865 /* Reset trigger stage. */
dc9dbe94 866 devc->trigger_stage = 0;
6c6781b6
JH
867 }
868 }
869 }
610dbb70 870
dc9dbe94 871 if (devc->trigger_stage == TRIGGER_FIRED) {
6c6781b6 872 /* Send the incoming transfer to the session bus. */
b99457f0 873 trigger_offset_bytes = trigger_offset * sample_width;
6c6781b6
JH
874 packet.type = SR_DF_LOGIC;
875 packet.payload = &logic;
d1ddc7a9
JH
876 logic.length = transfer->actual_length - trigger_offset_bytes;
877 logic.unitsize = sample_width;
878 logic.data = cur_buf + trigger_offset_bytes;
3e9b7f9c 879 sr_session_send(devc->cb_data, &packet);
6c6781b6 880
dc9dbe94
BV
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);
0caa1ef0
LPC
885 free_transfer(transfer);
886 return;
6c6781b6
JH
887 }
888 } else {
889 /*
890 * TODO: Buffer pre-trigger data in capture
891 * ratio-sized buffer.
892 */
610dbb70 893 }
17dff8a1
LPC
894
895 resubmit_transfer(transfer);
610dbb70
JH
896}
897
5af666a9
LPC
898static unsigned int to_bytes_per_ms(unsigned int samplerate)
899{
900 return samplerate / 1000;
901}
902
dc9dbe94 903static size_t get_buffer_size(struct dev_context *devc)
5af666a9
LPC
904{
905 size_t s;
906
b99457f0
UH
907 /*
908 * The buffer should be large enough to hold 10ms of data and
909 * a multiple of 512.
910 */
dc9dbe94 911 s = 10 * to_bytes_per_ms(devc->cur_samplerate);
5af666a9
LPC
912 return (s + 511) & ~511;
913}
914
dc9dbe94 915static unsigned int get_number_of_transfers(struct dev_context *devc)
5af666a9
LPC
916{
917 unsigned int n;
918
b99457f0 919 /* Total buffer size should be able to hold about 500ms of data. */
dc9dbe94 920 n = 500 * to_bytes_per_ms(devc->cur_samplerate) / get_buffer_size(devc);
5af666a9
LPC
921
922 if (n > NUM_SIMUL_TRANSFERS)
923 return NUM_SIMUL_TRANSFERS;
924
925 return n;
926}
927
dc9dbe94 928static unsigned int get_timeout(struct dev_context *devc)
5af666a9
LPC
929{
930 size_t total_size;
931 unsigned int timeout;
932
dc9dbe94
BV
933 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
934 timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
b99457f0 935 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
5af666a9
LPC
936}
937
3ffb6964
BV
938static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
939 void *cb_data)
f302a082 940{
dc9dbe94 941 struct dev_context *devc;
b99457f0 942 struct drv_context *drvc;
250a78c7 943 struct sr_usb_dev_inst *usb;
610dbb70
JH
944 struct libusb_transfer *transfer;
945 const struct libusb_pollfd **lupfd;
b99457f0 946 unsigned int i, timeout, num_transfers;
5af666a9 947 int ret;
610dbb70 948 unsigned char *buf;
b99457f0 949 size_t size;
610dbb70 950
e73ffd42
BV
951 if (sdi->status != SR_ST_ACTIVE)
952 return SR_ERR_DEV_CLOSED;
953
b99457f0 954 drvc = di->priv;
dc9dbe94 955 devc = sdi->priv;
250a78c7 956 usb = sdi->conn;
b99457f0 957
2a67abfe 958 /* Configures devc->trigger_* and devc->sample_wide */
014359e3 959 if (configure_probes(sdi) != SR_OK) {
b99457f0 960 sr_err("Failed to configure probes.");
014359e3
BV
961 return SR_ERR;
962 }
963
3e9b7f9c 964 devc->cb_data = cb_data;
dc9dbe94
BV
965 devc->num_samples = 0;
966 devc->empty_transfer_count = 0;
610dbb70 967
b99457f0
UH
968 timeout = get_timeout(devc);
969 num_transfers = get_number_of_transfers(devc);
970 size = get_buffer_size(devc);
2a67abfe 971 devc->submitted_transfers = 0;
5af666a9 972
dc9dbe94 973 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
886a52b6 974 if (!devc->transfers) {
f427daef 975 sr_err("USB transfers malloc failed.");
886a52b6
UH
976 return SR_ERR_MALLOC;
977 }
0caa1ef0 978
dc9dbe94 979 devc->num_transfers = num_transfers;
5af666a9 980 for (i = 0; i < num_transfers; i++) {
610dbb70 981 if (!(buf = g_try_malloc(size))) {
b99457f0 982 sr_err("USB transfer buffer malloc failed.");
610dbb70
JH
983 return SR_ERR_MALLOC;
984 }
985 transfer = libusb_alloc_transfer(0);
250a78c7 986 libusb_fill_bulk_transfer(transfer, usb->devhdl,
610dbb70 987 2 | LIBUSB_ENDPOINT_IN, buf, size,
dc9dbe94 988 receive_transfer, devc, timeout);
d4928d71 989 if ((ret = libusb_submit_transfer(transfer)) != 0) {
b99457f0
UH
990 sr_err("Failed to submit transfer: %s.",
991 libusb_error_name(ret));
610dbb70
JH
992 libusb_free_transfer(transfer);
993 g_free(buf);
dc9dbe94 994 abort_acquisition(devc);
610dbb70
JH
995 return SR_ERR;
996 }
dc9dbe94
BV
997 devc->transfers[i] = transfer;
998 devc->submitted_transfers++;
610dbb70
JH
999 }
1000
d4abb463 1001 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
0a7da5f8
BV
1002 for (i = 0; lupfd[i]; i++);
1003 if (!(devc->usbfd = g_try_malloc(sizeof(struct libusb_pollfd) * (i + 1))))
1004 return SR_ERR;
1005 for (i = 0; lupfd[i]; i++) {
610dbb70 1006 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
5af666a9 1007 timeout, receive_data, NULL);
0a7da5f8
BV
1008 devc->usbfd[i] = lupfd[i]->fd;
1009 }
1010 devc->usbfd[i] = -1;
1011 free(lupfd);
610dbb70 1012
4afdfd46 1013 /* Send header packet to the session bus. */
29a27196 1014 std_session_send_df_header(cb_data, LOG_PREFIX);
f366e86c 1015
250a78c7 1016 if ((ret = command_start_acquisition (usb->devhdl,
dc9dbe94
BV
1017 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1018 abort_acquisition(devc);
ebc34738 1019 return ret;
017375d1
JH
1020 }
1021
f302a082
JH
1022 return SR_OK;
1023}
1024
69b07d14 1025static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
f302a082 1026{
2e526f4a 1027 (void)cb_data;
5da93902 1028
2e526f4a 1029 abort_acquisition(sdi->priv);
5da93902 1030
f302a082
JH
1031 return SR_OK;
1032}
1033
c09f0b57 1034SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
f302a082 1035 .name = "fx2lafw",
2e7cb004 1036 .longname = "fx2lafw (generic driver for FX2 based LAs)",
f302a082
JH
1037 .api_version = 1,
1038 .init = hw_init,
1039 .cleanup = hw_cleanup,
61136ea6 1040 .scan = hw_scan,
811deee4
BV
1041 .dev_list = hw_dev_list,
1042 .dev_clear = clear_instances,
035a1078
BV
1043 .config_get = config_get,
1044 .config_set = config_set,
a1c743fc 1045 .config_list = config_list,
f302a082
JH
1046 .dev_open = hw_dev_open,
1047 .dev_close = hw_dev_close,
f302a082
JH
1048 .dev_acquisition_start = hw_dev_acquisition_start,
1049 .dev_acquisition_stop = hw_dev_acquisition_stop,
dc9dbe94 1050 .priv = NULL,
f302a082 1051};