]> sigrok.org Git - libsigrok.git/blame - hardware/fx2lafw/fx2lafw.c
fx2lafw: Say if chip is old FX2 or FX2LP
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
CommitLineData
f302a082
JH
1/*
2 * This file is part of the sigrok project.
3 *
cf94c816 4 * Copyright (C) 2010-2012 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
915f7cc8 84static const int hwcaps[] = {
8b35f474
JH
85 SR_HWCAP_LOGIC_ANALYZER,
86 SR_HWCAP_SAMPLERATE,
87
88 /* These are really implemented in the driver, not the hardware. */
89 SR_HWCAP_LIMIT_SAMPLES,
90 SR_HWCAP_CONTINUOUS,
772a0e61 91 0,
8b35f474
JH
92};
93
da686568 94static const char *probe_names[] = {
b36e7153 95 "0", "1", "2", "3", "4", "5", "6", "7",
78693401
UH
96 "8", "9", "10", "11", "12", "13", "14", "15",
97 NULL,
8b35f474
JH
98};
99
a533743d 100static const uint64_t supported_samplerates[] = {
79dc6498
JH
101 SR_KHZ(20),
102 SR_KHZ(25),
897c1a2e
JH
103 SR_KHZ(50),
104 SR_KHZ(100),
9304d576
JH
105 SR_KHZ(200),
106 SR_KHZ(250),
107 SR_KHZ(500),
8b35f474
JH
108 SR_MHZ(1),
109 SR_MHZ(2),
110 SR_MHZ(3),
111 SR_MHZ(4),
112 SR_MHZ(6),
113 SR_MHZ(8),
114 SR_MHZ(12),
115 SR_MHZ(16),
772a0e61 116 SR_MHZ(24),
934cde02 117 0,
8b35f474
JH
118};
119
a533743d 120static const struct sr_samplerates samplerates = {
590b9f9a
UH
121 0,
122 0,
123 0,
124 supported_samplerates,
8b35f474
JH
125};
126
a8cc8e44 127SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
a873c594 128static struct sr_dev_driver *di = &fx2lafw_driver_info;
25a0f108 129static int hw_dev_close(struct sr_dev_inst *sdi);
6f4b1868
BV
130static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
131 const void *value);
69b07d14 132static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
610dbb70 133
b1eeb67e
JH
134/**
135 * Check the USB configuration to determine if this is an fx2lafw device.
136 *
f9a69557
UH
137 * @return TRUE if the device's configuration profile match fx2lafw
138 * configuration, FALSE otherwise.
b1eeb67e 139 */
f9a69557 140static gboolean check_conf_profile(libusb_device *dev)
b1eeb67e
JH
141{
142 struct libusb_device_descriptor des;
6b73d9a5
BV
143 struct libusb_device_handle *hdl;
144 gboolean ret;
145 unsigned char strdesc[64];
b1eeb67e 146
6b73d9a5
BV
147 hdl = NULL;
148 ret = FALSE;
b1eeb67e 149 while (!ret) {
da686568 150 /* Assume the FW has not been loaded, unless proven wrong. */
b1eeb67e
JH
151 if (libusb_get_device_descriptor(dev, &des) != 0)
152 break;
153
6b73d9a5 154 if (libusb_open(dev, &hdl) != 0)
b1eeb67e
JH
155 break;
156
6b73d9a5 157 if (libusb_get_string_descriptor_ascii(hdl,
b99457f0 158 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
b1eeb67e 159 break;
6b73d9a5 160 if (strncmp((const char *)strdesc, "sigrok", 6))
b1eeb67e
JH
161 break;
162
6b73d9a5
BV
163 if (libusb_get_string_descriptor_ascii(hdl,
164 des.iProduct, strdesc, sizeof(strdesc)) < 0)
b1eeb67e 165 break;
6b73d9a5 166 if (strncmp((const char *)strdesc, "fx2lafw", 7))
b1eeb67e
JH
167 break;
168
b1eeb67e 169 /* If we made it here, it must be an fx2lafw. */
f9a69557 170 ret = TRUE;
b1eeb67e 171 }
6b73d9a5
BV
172 if (hdl)
173 libusb_close(hdl);
b1eeb67e
JH
174
175 return ret;
176}
177
25a0f108 178static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
43125c69
JH
179{
180 libusb_device **devlist;
181 struct libusb_device_descriptor des;
dc9dbe94 182 struct dev_context *devc;
b99457f0 183 struct drv_context *drvc;
13bf7ecc 184 struct version_info vi;
b99457f0 185 int ret, skip, i, device_count;
1e94408a 186 uint8_t revid;
43125c69 187
b99457f0 188 drvc = di->priv;
dc9dbe94 189 devc = sdi->priv;
43125c69
JH
190
191 if (sdi->status == SR_ST_ACTIVE)
b99457f0 192 /* Device is already in use. */
43125c69
JH
193 return SR_ERR;
194
195 skip = 0;
b99457f0 196 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
6fbe5e60 197 if (device_count < 0) {
b99457f0
UH
198 sr_err("Failed to get device list: %s.",
199 libusb_error_name(device_count));
6fbe5e60
JH
200 return SR_ERR;
201 }
202
203 for (i = 0; i < device_count; i++) {
ebc34738 204 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
f427daef 205 sr_err("Failed to get device descriptor: %s.",
d4928d71 206 libusb_error_name(ret));
43125c69
JH
207 continue;
208 }
209
dc9dbe94
BV
210 if (des.idVendor != devc->profile->vid
211 || des.idProduct != devc->profile->pid)
43125c69
JH
212 continue;
213
214 if (sdi->status == SR_ST_INITIALIZING) {
25a0f108 215 if (skip != sdi->index) {
43125c69
JH
216 /* Skip devices of this type that aren't the one we want. */
217 skip += 1;
218 continue;
219 }
220 } else if (sdi->status == SR_ST_INACTIVE) {
221 /*
222 * This device is fully enumerated, so we need to find
223 * this device by vendor, product, bus and address.
224 */
dc9dbe94
BV
225 if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
226 || libusb_get_device_address(devlist[i]) != devc->usb->address)
b99457f0 227 /* This is not the one. */
43125c69
JH
228 continue;
229 }
230
dc9dbe94
BV
231 if (!(ret = libusb_open(devlist[i], &devc->usb->devhdl))) {
232 if (devc->usb->address == 0xff)
43125c69 233 /*
b99457f0
UH
234 * First time we touch this device after FW
235 * upload, so we don't know the address yet.
43125c69 236 */
dc9dbe94 237 devc->usb->address = libusb_get_device_address(devlist[i]);
43125c69 238 } else {
f427daef 239 sr_err("Failed to open device: %s.",
d4928d71 240 libusb_error_name(ret));
13bf7ecc
JH
241 break;
242 }
243
dc9dbe94 244 ret = command_get_fw_version(devc->usb->devhdl, &vi);
44dfd483 245 if (ret != SR_OK) {
b99457f0 246 sr_err("Failed to get firmware version.");
13bf7ecc 247 break;
43125c69
JH
248 }
249
dc9dbe94 250 ret = command_get_revid_version(devc->usb->devhdl, &revid);
1e94408a 251 if (ret != SR_OK) {
b99457f0 252 sr_err("Failed to get REVID.");
1e94408a
UH
253 break;
254 }
255
0a8c0c32
UH
256 /*
257 * Changes in major version mean incompatible/API changes, so
258 * bail out if we encounter an incompatible version.
259 * Different minor versions are OK, they should be compatible.
260 */
261 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
f427daef 262 sr_err("Expected firmware version %d.x, "
0a8c0c32
UH
263 "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
264 vi.major, vi.minor);
13bf7ecc
JH
265 break;
266 }
267
268 sdi->status = SR_ST_ACTIVE;
b99457f0 269 sr_info("Opened device %d on %d.%d, "
cbc80f8f 270 "interface %d, firmware %d.%d.",
dc9dbe94 271 sdi->index, devc->usb->bus, devc->usb->address,
cbc80f8f
AG
272 USB_INTERFACE, vi.major, vi.minor);
273
274 sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
275 revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
13bf7ecc 276
43125c69
JH
277 break;
278 }
279 libusb_free_device_list(devlist, 1);
280
281 if (sdi->status != SR_ST_ACTIVE)
282 return SR_ERR;
283
284 return SR_OK;
285}
286
014359e3 287static int configure_probes(const struct sr_dev_inst *sdi)
6c6781b6 288{
014359e3 289 struct dev_context *devc;
6c6781b6
JH
290 struct sr_probe *probe;
291 GSList *l;
292 int probe_bit, stage, i;
293 char *tc;
294
014359e3 295 devc = sdi->priv;
6c6781b6 296 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
dc9dbe94
BV
297 devc->trigger_mask[i] = 0;
298 devc->trigger_value[i] = 0;
6c6781b6
JH
299 }
300
301 stage = -1;
014359e3 302 for (l = sdi->probes; l; l = l->next) {
6c6781b6
JH
303 probe = (struct sr_probe *)l->data;
304 if (probe->enabled == FALSE)
305 continue;
d1ddc7a9 306
b35c8293 307 if (probe->index > 7)
dc9dbe94 308 devc->sample_wide = TRUE;
d1ddc7a9 309
b35c8293 310 probe_bit = 1 << (probe->index);
6c6781b6
JH
311 if (!(probe->trigger))
312 continue;
313
314 stage = 0;
315 for (tc = probe->trigger; *tc; tc++) {
dc9dbe94 316 devc->trigger_mask[stage] |= probe_bit;
6c6781b6 317 if (*tc == '1')
dc9dbe94 318 devc->trigger_value[stage] |= probe_bit;
6c6781b6
JH
319 stage++;
320 if (stage > NUM_TRIGGER_STAGES)
321 return SR_ERR;
322 }
323 }
324
325 if (stage == -1)
326 /*
327 * We didn't configure any triggers, make sure acquisition
328 * doesn't wait for any.
329 */
dc9dbe94 330 devc->trigger_stage = TRIGGER_FIRED;
6c6781b6 331 else
dc9dbe94 332 devc->trigger_stage = 0;
6c6781b6
JH
333
334 return SR_OK;
335}
336
dc9dbe94 337static struct dev_context *fx2lafw_dev_new(void)
187b3582 338{
dc9dbe94 339 struct dev_context *devc;
187b3582 340
dc9dbe94 341 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
b99457f0 342 sr_err("Device context malloc failed.");
187b3582
JH
343 return NULL;
344 }
345
dc9dbe94 346 devc->trigger_stage = TRIGGER_FIRED;
6c6781b6 347
dc9dbe94 348 return devc;
187b3582 349}
f302a082 350
f69b47f0
BV
351static int clear_instances(void)
352{
353 GSList *l;
354 struct sr_dev_inst *sdi;
dc9dbe94
BV
355 struct drv_context *drvc;
356 struct dev_context *devc;
f69b47f0
BV
357 int ret;
358
a873c594 359 drvc = di->priv;
f69b47f0 360 ret = SR_OK;
dc9dbe94 361 for (l = drvc->instances; l; l = l->next) {
f69b47f0
BV
362 if (!(sdi = l->data)) {
363 /* Log error, but continue cleaning up the rest. */
b99457f0 364 sr_err("sdi was NULL, continuing.");
f69b47f0
BV
365 ret = SR_ERR_BUG;
366 continue;
367 }
dc9dbe94 368 if (!(devc = sdi->priv)) {
f69b47f0 369 /* Log error, but continue cleaning up the rest. */
b99457f0 370 sr_err("sdi->priv was NULL, continuing.");
f69b47f0
BV
371 ret = SR_ERR_BUG;
372 continue;
373 }
25a0f108 374 hw_dev_close(sdi);
fabe59b3 375 sr_usb_dev_inst_free(devc->usb);
f69b47f0
BV
376 sdi = l->data;
377 sr_dev_inst_free(sdi);
378 }
379
dc9dbe94
BV
380 g_slist_free(drvc->instances);
381 drvc->instances = NULL;
f69b47f0
BV
382
383 return ret;
384}
385
34f06b90 386static int hw_init(struct sr_context *sr_ctx)
61136ea6 387{
dc9dbe94
BV
388 struct drv_context *drvc;
389
390 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
f427daef 391 sr_err("Driver context malloc failed.");
886a52b6 392 return SR_ERR_MALLOC;
dc9dbe94 393 }
61136ea6 394
1ebe4b4e 395 drvc->sr_ctx = sr_ctx;
a873c594 396 di->priv = drvc;
dc9dbe94 397
61136ea6
BV
398 return SR_OK;
399}
400
3a7a22cb 401static GSList *hw_scan(GSList *options)
f302a082 402{
3a7a22cb 403 GSList *devices;
187b3582 404 struct libusb_device_descriptor des;
3a7a22cb 405 struct sr_dev_inst *sdi;
da686568 406 const struct fx2lafw_profile *prof;
dc9dbe94
BV
407 struct drv_context *drvc;
408 struct dev_context *devc;
3a7a22cb 409 struct sr_probe *probe;
187b3582 410 libusb_device **devlist;
3a7a22cb
BV
411 int devcnt, num_logic_probes, ret, i, j;
412
3a7a22cb 413 (void)options;
64d33dc2 414
a873c594 415 drvc = di->priv;
187b3582 416
f69b47f0
BV
417 /* This scan always invalidates any previous scans. */
418 clear_instances();
419
921634ec 420 /* Find all fx2lafw compatible devices and upload firmware to them. */
3a7a22cb 421 devices = NULL;
d4abb463 422 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
187b3582
JH
423 for (i = 0; devlist[i]; i++) {
424
ebc34738 425 if ((ret = libusb_get_device_descriptor(
7ae2f9d5 426 devlist[i], &des)) != 0) {
f427daef 427 sr_warn("Failed to get device descriptor: %s.",
d4928d71 428 libusb_error_name(ret));
187b3582
JH
429 continue;
430 }
431
da686568 432 prof = NULL;
187b3582
JH
433 for (j = 0; supported_fx2[j].vid; j++) {
434 if (des.idVendor == supported_fx2[j].vid &&
435 des.idProduct == supported_fx2[j].pid) {
da686568 436 prof = &supported_fx2[j];
187b3582
JH
437 }
438 }
439
b99457f0 440 /* Skip if the device was not found. */
da686568 441 if (!prof)
187b3582
JH
442 continue;
443
dc9dbe94 444 devcnt = g_slist_length(drvc->instances);
187b3582 445 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
da686568 446 prof->vendor, prof->model, prof->model_version);
f4a9e5c0 447 if (!sdi)
25a0f108 448 return NULL;
a873c594 449 sdi->driver = di;
187b3582 450
06717a8a
BV
451 /* Fill in probelist according to this device's profile. */
452 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
c5e82ca5 453 for (j = 0; j < num_logic_probes; j++) {
06717a8a
BV
454 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
455 probe_names[j])))
25a0f108 456 return NULL;
06717a8a
BV
457 sdi->probes = g_slist_append(sdi->probes, probe);
458 }
459
dc9dbe94
BV
460 devc = fx2lafw_dev_new();
461 devc->profile = prof;
462 sdi->priv = devc;
463 drvc->instances = g_slist_append(drvc->instances, sdi);
a8cc8e44 464 devices = g_slist_append(devices, sdi);
187b3582 465
b1eeb67e
JH
466 if (check_conf_profile(devlist[i])) {
467 /* Already has the firmware, so fix the new address. */
f427daef 468 sr_dbg("Found an fx2lafw device.");
b1eeb67e 469 sdi->status = SR_ST_INACTIVE;
dc9dbe94 470 devc->usb = sr_usb_dev_inst_new
b1eeb67e
JH
471 (libusb_get_bus_number(devlist[i]),
472 libusb_get_device_address(devlist[i]), NULL);
473 } else {
f8b07fc6 474 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
da686568 475 prof->firmware) == SR_OK)
b99457f0 476 /* Store when this device's FW was updated. */
dc9dbe94 477 devc->fw_updated = g_get_monotonic_time();
b1eeb67e 478 else
f427daef 479 sr_err("Firmware upload failed for "
7ae2f9d5 480 "device %d.", devcnt);
dc9dbe94 481 devc->usb = sr_usb_dev_inst_new
b1eeb67e
JH
482 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
483 }
187b3582
JH
484 }
485 libusb_free_device_list(devlist, 1);
486
3a7a22cb 487 return devices;
f302a082
JH
488}
489
811deee4
BV
490static GSList *hw_dev_list(void)
491{
492 struct drv_context *drvc;
493
a873c594 494 drvc = di->priv;
811deee4
BV
495
496 return drvc->instances;
497}
498
25a0f108 499static int hw_dev_open(struct sr_dev_inst *sdi)
f302a082 500{
dc9dbe94 501 struct dev_context *devc;
e8bd58ff
UH
502 int ret;
503 int64_t timediff_us, timediff_ms;
43125c69 504
dc9dbe94 505 devc = sdi->priv;
43125c69
JH
506
507 /*
f60fdf6e
UH
508 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
509 * milliseconds for the FX2 to renumerate.
43125c69 510 */
3b6c1930 511 ret = SR_ERR;
dc9dbe94 512 if (devc->fw_updated > 0) {
f427daef 513 sr_info("Waiting for device to reset.");
b99457f0 514 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
43125c69 515 g_usleep(300 * 1000);
e8bd58ff 516 timediff_ms = 0;
f60fdf6e 517 while (timediff_ms < MAX_RENUM_DELAY_MS) {
25a0f108 518 if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
43125c69
JH
519 break;
520 g_usleep(100 * 1000);
e8bd58ff 521
dc9dbe94 522 timediff_us = g_get_monotonic_time() - devc->fw_updated;
3b6c1930 523 timediff_ms = timediff_us / 1000;
b99457f0 524 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
43125c69 525 }
443a14d8
AG
526 if (ret != SR_OK) {
527 sr_err("Device failed to renumerate.");
528 return SR_ERR;
529 }
c0bf69c2 530 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
43125c69 531 } else {
443a14d8 532 sr_info("Firmware upload was not needed.");
25a0f108 533 ret = fx2lafw_dev_open(sdi);
43125c69
JH
534 }
535
ebc34738 536 if (ret != SR_OK) {
f427daef 537 sr_err("Unable to open device.");
43125c69
JH
538 return SR_ERR;
539 }
378abfea 540
dc9dbe94 541 devc = sdi->priv;
43125c69 542
dc9dbe94 543 ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
ebc34738 544 if (ret != 0) {
0c156e06
JH
545 switch(ret) {
546 case LIBUSB_ERROR_BUSY:
f427daef 547 sr_err("Unable to claim USB interface. Another "
b99457f0 548 "program or driver has already claimed it.");
0c156e06 549 break;
0c156e06 550 case LIBUSB_ERROR_NO_DEVICE:
f427daef 551 sr_err("Device has been disconnected.");
0c156e06 552 break;
0c156e06 553 default:
f427daef 554 sr_err("Unable to claim interface: %s.",
d4928d71 555 libusb_error_name(ret));
0c156e06
JH
556 break;
557 }
558
43125c69
JH
559 return SR_ERR;
560 }
561
dc9dbe94 562 if (devc->cur_samplerate == 0) {
f92994fd 563 /* Samplerate hasn't been set; default to the slowest one. */
6f4b1868 564 if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
590b9f9a 565 &supported_samplerates[0]) == SR_ERR)
f92994fd
JH
566 return SR_ERR;
567 }
568
f302a082
JH
569 return SR_OK;
570}
571
25a0f108 572static int hw_dev_close(struct sr_dev_inst *sdi)
f302a082 573{
dc9dbe94 574 struct dev_context *devc;
f1898235 575
dc9dbe94
BV
576 devc = sdi->priv;
577 if (devc->usb->devhdl == NULL)
25a0f108 578 return SR_ERR;
f1898235 579
b99457f0 580 sr_info("Closing device %d on %d.%d, interface %d.",
dc9dbe94
BV
581 sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE);
582 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
583 libusb_close(devc->usb->devhdl);
584 devc->usb->devhdl = NULL;
25a0f108 585 sdi->status = SR_ST_INACTIVE;
f1898235 586
f302a082
JH
587 return SR_OK;
588}
589
590static int hw_cleanup(void)
591{
dc9dbe94 592 struct drv_context *drvc;
f69b47f0 593 int ret;
187b3582 594
a873c594 595 if (!(drvc = di->priv))
dc9dbe94
BV
596 return SR_OK;
597
f69b47f0 598 ret = clear_instances();
187b3582 599
dc9dbe94 600 g_free(drvc);
a873c594 601 di->priv = NULL;
187b3582 602
62bc70e4 603 return ret;
f302a082
JH
604}
605
cbd798f4 606static int hw_info_get(int info_id, const void **data,
6e9339aa 607 const struct sr_dev_inst *sdi)
f302a082 608{
dc9dbe94 609 struct dev_context *devc;
8b35f474 610
cbd798f4 611 switch (info_id) {
a27999e6
BV
612 case SR_DI_HWCAPS:
613 *data = hwcaps;
614 break;
8b35f474 615 case SR_DI_NUM_PROBES:
6e9339aa 616 if (sdi) {
dc9dbe94 617 devc = sdi->priv;
6e9339aa 618 *data = GINT_TO_POINTER(
dc9dbe94 619 (devc->profile->dev_caps & DEV_CAPS_16BIT) ?
6e9339aa
BV
620 16 : 8);
621 } else
622 return SR_ERR;
623 break;
8b35f474 624 case SR_DI_PROBE_NAMES:
6e9339aa
BV
625 *data = probe_names;
626 break;
8b35f474 627 case SR_DI_SAMPLERATES:
6e9339aa
BV
628 *data = &samplerates;
629 break;
8b35f474 630 case SR_DI_TRIGGER_TYPES:
6e9339aa
BV
631 *data = TRIGGER_TYPES;
632 break;
e3186647 633 case SR_DI_CUR_SAMPLERATE:
6e9339aa 634 if (sdi) {
dc9dbe94
BV
635 devc = sdi->priv;
636 *data = &devc->cur_samplerate;
6e9339aa
BV
637 } else
638 return SR_ERR;
639 break;
640 default:
641 return SR_ERR_ARG;
8b35f474
JH
642 }
643
6e9339aa 644 return SR_OK;
f302a082
JH
645}
646
6f4b1868
BV
647static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
648 const void *value)
f302a082 649{
dc9dbe94 650 struct dev_context *devc;
7cb621d4
JH
651 int ret;
652
dc9dbe94 653 devc = sdi->priv;
7cb621d4 654
e3186647 655 if (hwcap == SR_HWCAP_SAMPLERATE) {
dc9dbe94 656 devc->cur_samplerate = *(const uint64_t *)value;
e3186647 657 ret = SR_OK;
e3186647 658 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
dc9dbe94 659 devc->limit_samples = *(const uint64_t *)value;
7cb621d4
JH
660 ret = SR_OK;
661 } else {
662 ret = SR_ERR;
663 }
664
665 return ret;
f302a082
JH
666}
667
1f9813eb 668static int receive_data(int fd, int revents, void *cb_data)
610dbb70
JH
669{
670 struct timeval tv;
b99457f0 671 struct drv_context *drvc;
610dbb70 672
610dbb70
JH
673 (void)fd;
674 (void)revents;
1f9813eb 675 (void)cb_data;
610dbb70 676
b99457f0
UH
677 drvc = di->priv;
678
610dbb70 679 tv.tv_sec = tv.tv_usec = 0;
d4abb463 680 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
610dbb70
JH
681
682 return TRUE;
683}
684
dc9dbe94 685static void abort_acquisition(struct dev_context *devc)
cb61e9f7 686{
e7d087bf 687 int i;
0caa1ef0 688
dc9dbe94 689 devc->num_samples = -1;
0caa1ef0 690
dc9dbe94
BV
691 for (i = devc->num_transfers - 1; i >= 0; i--) {
692 if (devc->transfers[i])
693 libusb_cancel_transfer(devc->transfers[i]);
0caa1ef0 694 }
cb61e9f7
JH
695}
696
dc9dbe94 697static void finish_acquisition(struct dev_context *devc)
2e526f4a
JH
698{
699 struct sr_datafeed_packet packet;
a873c594 700 struct drv_context *drvc = di->priv;
b99457f0 701 const struct libusb_pollfd **lupfd;
cb61e9f7 702 int i;
2e526f4a 703
b99457f0 704 /* Terminate session. */
2e526f4a 705 packet.type = SR_DF_END;
dc9dbe94 706 sr_session_send(devc->session_dev_id, &packet);
2e526f4a 707
b99457f0
UH
708 /* Remove fds from polling. */
709 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
cb61e9f7
JH
710 for (i = 0; lupfd[i]; i++)
711 sr_source_remove(lupfd[i]->fd);
712 free(lupfd); /* NOT g_free()! */
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;
dc9dbe94 838 sr_session_send(devc->session_dev_id, &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;
849 sr_session_send(devc->session_dev_id, &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;
dc9dbe94 879 sr_session_send(devc->session_dev_id, &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{
bd47acab
LPC
941 struct sr_datafeed_packet packet;
942 struct sr_datafeed_header header;
f366e86c 943 struct sr_datafeed_meta_logic meta;
dc9dbe94 944 struct dev_context *devc;
b99457f0 945 struct drv_context *drvc;
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;
b99457f0 955
dc9dbe94 956 if (devc->submitted_transfers != 0)
c03f0450
LPC
957 return SR_ERR;
958
014359e3 959 if (configure_probes(sdi) != SR_OK) {
b99457f0 960 sr_err("Failed to configure probes.");
014359e3
BV
961 return SR_ERR;
962 }
963
dc9dbe94
BV
964 devc->session_dev_id = cb_data;
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);
5af666a9 971
dc9dbe94 972 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
886a52b6 973 if (!devc->transfers) {
f427daef 974 sr_err("USB transfers malloc failed.");
886a52b6
UH
975 return SR_ERR_MALLOC;
976 }
0caa1ef0 977
dc9dbe94 978 devc->num_transfers = num_transfers;
0caa1ef0 979
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);
dc9dbe94 986 libusb_fill_bulk_transfer(transfer, devc->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);
610dbb70
JH
1002 for (i = 0; lupfd[i]; i++)
1003 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
5af666a9 1004 timeout, receive_data, NULL);
610dbb70
JH
1005 free(lupfd); /* NOT g_free()! */
1006
bd47acab
LPC
1007 packet.type = SR_DF_HEADER;
1008 packet.payload = &header;
1009 header.feed_version = 1;
1010 gettimeofday(&header.starttime, NULL);
1011 sr_session_send(cb_data, &packet);
f366e86c
BV
1012
1013 /* Send metadata about the SR_DF_LOGIC packets to come. */
bd47acab
LPC
1014 packet.type = SR_DF_META_LOGIC;
1015 packet.payload = &meta;
dc9dbe94
BV
1016 meta.samplerate = devc->cur_samplerate;
1017 meta.num_probes = devc->sample_wide ? 16 : 8;
bd47acab 1018 sr_session_send(cb_data, &packet);
610dbb70 1019
b99457f0 1020 if ((ret = command_start_acquisition(devc->usb->devhdl,
dc9dbe94
BV
1021 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1022 abort_acquisition(devc);
ebc34738 1023 return ret;
017375d1
JH
1024 }
1025
f302a082
JH
1026 return SR_OK;
1027}
1028
3cd3a20b 1029/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
69b07d14 1030static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
f302a082 1031{
2e526f4a 1032 (void)cb_data;
5da93902 1033
2e526f4a 1034 abort_acquisition(sdi->priv);
5da93902 1035
f302a082
JH
1036 return SR_OK;
1037}
1038
c09f0b57 1039SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
f302a082 1040 .name = "fx2lafw",
2e7cb004 1041 .longname = "fx2lafw (generic driver for FX2 based LAs)",
f302a082
JH
1042 .api_version = 1,
1043 .init = hw_init,
1044 .cleanup = hw_cleanup,
61136ea6 1045 .scan = hw_scan,
811deee4
BV
1046 .dev_list = hw_dev_list,
1047 .dev_clear = clear_instances,
f302a082
JH
1048 .dev_open = hw_dev_open,
1049 .dev_close = hw_dev_close,
6e9339aa 1050 .info_get = hw_info_get,
f302a082
JH
1051 .dev_config_set = hw_dev_config_set,
1052 .dev_acquisition_start = hw_dev_acquisition_start,
1053 .dev_acquisition_stop = hw_dev_acquisition_stop,
dc9dbe94 1054 .priv = NULL,
f302a082 1055};