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