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