]> sigrok.org Git - libsigrok.git/blame - hardware/fx2lafw/fx2lafw.c
fx2lafw: Tidied probe_names
[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
JH
95 "0", "1", "2", "3", "4", "5", "6", "7",
96 "8", "9", "10", "11", "12", "13", "14", "15", NULL,
8b35f474
JH
97};
98
a533743d 99static const uint64_t supported_samplerates[] = {
79dc6498
JH
100 SR_KHZ(20),
101 SR_KHZ(25),
897c1a2e
JH
102 SR_KHZ(50),
103 SR_KHZ(100),
9304d576
JH
104 SR_KHZ(200),
105 SR_KHZ(250),
106 SR_KHZ(500),
8b35f474
JH
107 SR_MHZ(1),
108 SR_MHZ(2),
109 SR_MHZ(3),
110 SR_MHZ(4),
111 SR_MHZ(6),
112 SR_MHZ(8),
113 SR_MHZ(12),
114 SR_MHZ(16),
772a0e61 115 SR_MHZ(24),
934cde02 116 0,
8b35f474
JH
117};
118
a533743d 119static const struct sr_samplerates samplerates = {
590b9f9a
UH
120 0,
121 0,
122 0,
123 supported_samplerates,
8b35f474
JH
124};
125
a8cc8e44 126SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
a873c594 127static struct sr_dev_driver *di = &fx2lafw_driver_info;
25a0f108 128static int hw_dev_close(struct sr_dev_inst *sdi);
6f4b1868
BV
129static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
130 const void *value);
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, "
1e94408a 269 "interface %d, firmware %d.%d, REVID %d.",
dc9dbe94 270 sdi->index, devc->usb->bus, devc->usb->address,
1e94408a 271 USB_INTERFACE, vi.major, vi.minor, revid);
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{
349 GSList *l;
350 struct sr_dev_inst *sdi;
dc9dbe94
BV
351 struct drv_context *drvc;
352 struct dev_context *devc;
f69b47f0
BV
353 int ret;
354
a873c594 355 drvc = di->priv;
f69b47f0 356 ret = SR_OK;
dc9dbe94 357 for (l = drvc->instances; l; l = l->next) {
f69b47f0
BV
358 if (!(sdi = l->data)) {
359 /* Log error, but continue cleaning up the rest. */
b99457f0 360 sr_err("sdi was NULL, continuing.");
f69b47f0
BV
361 ret = SR_ERR_BUG;
362 continue;
363 }
dc9dbe94 364 if (!(devc = sdi->priv)) {
f69b47f0 365 /* Log error, but continue cleaning up the rest. */
b99457f0 366 sr_err("sdi->priv was NULL, continuing.");
f69b47f0
BV
367 ret = SR_ERR_BUG;
368 continue;
369 }
25a0f108 370 hw_dev_close(sdi);
fabe59b3 371 sr_usb_dev_inst_free(devc->usb);
f69b47f0
BV
372 sdi = l->data;
373 sr_dev_inst_free(sdi);
374 }
375
dc9dbe94
BV
376 g_slist_free(drvc->instances);
377 drvc->instances = NULL;
f69b47f0
BV
378
379 return ret;
380}
381
34f06b90 382static int hw_init(struct sr_context *sr_ctx)
61136ea6 383{
dc9dbe94
BV
384 struct drv_context *drvc;
385
386 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
f427daef 387 sr_err("Driver context malloc failed.");
886a52b6 388 return SR_ERR_MALLOC;
dc9dbe94 389 }
61136ea6 390
1ebe4b4e 391 drvc->sr_ctx = sr_ctx;
a873c594 392 di->priv = drvc;
dc9dbe94 393
61136ea6
BV
394 return SR_OK;
395}
396
3a7a22cb 397static GSList *hw_scan(GSList *options)
f302a082 398{
3a7a22cb 399 GSList *devices;
187b3582 400 struct libusb_device_descriptor des;
3a7a22cb 401 struct sr_dev_inst *sdi;
da686568 402 const struct fx2lafw_profile *prof;
dc9dbe94
BV
403 struct drv_context *drvc;
404 struct dev_context *devc;
3a7a22cb 405 struct sr_probe *probe;
187b3582 406 libusb_device **devlist;
3a7a22cb
BV
407 int devcnt, num_logic_probes, ret, i, j;
408
3a7a22cb 409 (void)options;
64d33dc2 410
a873c594 411 drvc = di->priv;
187b3582 412
f69b47f0
BV
413 /* This scan always invalidates any previous scans. */
414 clear_instances();
415
921634ec 416 /* Find all fx2lafw compatible devices and upload firmware to them. */
3a7a22cb 417 devices = NULL;
d4abb463 418 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
187b3582
JH
419 for (i = 0; devlist[i]; i++) {
420
ebc34738 421 if ((ret = libusb_get_device_descriptor(
7ae2f9d5 422 devlist[i], &des)) != 0) {
f427daef 423 sr_warn("Failed to get device descriptor: %s.",
d4928d71 424 libusb_error_name(ret));
187b3582
JH
425 continue;
426 }
427
da686568 428 prof = NULL;
187b3582
JH
429 for (j = 0; supported_fx2[j].vid; j++) {
430 if (des.idVendor == supported_fx2[j].vid &&
431 des.idProduct == supported_fx2[j].pid) {
da686568 432 prof = &supported_fx2[j];
187b3582
JH
433 }
434 }
435
b99457f0 436 /* Skip if the device was not found. */
da686568 437 if (!prof)
187b3582
JH
438 continue;
439
dc9dbe94 440 devcnt = g_slist_length(drvc->instances);
187b3582 441 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
da686568 442 prof->vendor, prof->model, prof->model_version);
f4a9e5c0 443 if (!sdi)
25a0f108 444 return NULL;
a873c594 445 sdi->driver = di;
187b3582 446
06717a8a
BV
447 /* Fill in probelist according to this device's profile. */
448 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
c5e82ca5 449 for (j = 0; j < num_logic_probes; j++) {
06717a8a
BV
450 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
451 probe_names[j])))
25a0f108 452 return NULL;
06717a8a
BV
453 sdi->probes = g_slist_append(sdi->probes, probe);
454 }
455
dc9dbe94
BV
456 devc = fx2lafw_dev_new();
457 devc->profile = prof;
458 sdi->priv = devc;
459 drvc->instances = g_slist_append(drvc->instances, sdi);
a8cc8e44 460 devices = g_slist_append(devices, sdi);
187b3582 461
b1eeb67e
JH
462 if (check_conf_profile(devlist[i])) {
463 /* Already has the firmware, so fix the new address. */
f427daef 464 sr_dbg("Found an fx2lafw device.");
b1eeb67e 465 sdi->status = SR_ST_INACTIVE;
dc9dbe94 466 devc->usb = sr_usb_dev_inst_new
b1eeb67e
JH
467 (libusb_get_bus_number(devlist[i]),
468 libusb_get_device_address(devlist[i]), NULL);
469 } else {
f8b07fc6 470 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
da686568 471 prof->firmware) == SR_OK)
b99457f0 472 /* Store when this device's FW was updated. */
dc9dbe94 473 devc->fw_updated = g_get_monotonic_time();
b1eeb67e 474 else
f427daef 475 sr_err("Firmware upload failed for "
7ae2f9d5 476 "device %d.", devcnt);
dc9dbe94 477 devc->usb = sr_usb_dev_inst_new
b1eeb67e
JH
478 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
479 }
187b3582
JH
480 }
481 libusb_free_device_list(devlist, 1);
482
3a7a22cb 483 return devices;
f302a082
JH
484}
485
811deee4
BV
486static GSList *hw_dev_list(void)
487{
488 struct drv_context *drvc;
489
a873c594 490 drvc = di->priv;
811deee4
BV
491
492 return drvc->instances;
493}
494
25a0f108 495static int hw_dev_open(struct sr_dev_inst *sdi)
f302a082 496{
dc9dbe94 497 struct dev_context *devc;
e8bd58ff
UH
498 int ret;
499 int64_t timediff_us, timediff_ms;
43125c69 500
dc9dbe94 501 devc = sdi->priv;
43125c69
JH
502
503 /*
f60fdf6e
UH
504 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
505 * milliseconds for the FX2 to renumerate.
43125c69 506 */
3b6c1930 507 ret = SR_ERR;
dc9dbe94 508 if (devc->fw_updated > 0) {
f427daef 509 sr_info("Waiting for device to reset.");
b99457f0 510 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
43125c69 511 g_usleep(300 * 1000);
e8bd58ff 512 timediff_ms = 0;
f60fdf6e 513 while (timediff_ms < MAX_RENUM_DELAY_MS) {
25a0f108 514 if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
43125c69
JH
515 break;
516 g_usleep(100 * 1000);
e8bd58ff 517
dc9dbe94 518 timediff_us = g_get_monotonic_time() - devc->fw_updated;
3b6c1930 519 timediff_ms = timediff_us / 1000;
b99457f0 520 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
43125c69 521 }
443a14d8
AG
522 if (ret != SR_OK) {
523 sr_err("Device failed to renumerate.");
524 return SR_ERR;
525 }
c0bf69c2 526 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
43125c69 527 } else {
443a14d8 528 sr_info("Firmware upload was not needed.");
25a0f108 529 ret = fx2lafw_dev_open(sdi);
43125c69
JH
530 }
531
ebc34738 532 if (ret != SR_OK) {
f427daef 533 sr_err("Unable to open device.");
43125c69
JH
534 return SR_ERR;
535 }
378abfea 536
dc9dbe94 537 devc = sdi->priv;
43125c69 538
dc9dbe94 539 ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
ebc34738 540 if (ret != 0) {
0c156e06
JH
541 switch(ret) {
542 case LIBUSB_ERROR_BUSY:
f427daef 543 sr_err("Unable to claim USB interface. Another "
b99457f0 544 "program or driver has already claimed it.");
0c156e06 545 break;
0c156e06 546 case LIBUSB_ERROR_NO_DEVICE:
f427daef 547 sr_err("Device has been disconnected.");
0c156e06 548 break;
0c156e06 549 default:
f427daef 550 sr_err("Unable to claim interface: %s.",
d4928d71 551 libusb_error_name(ret));
0c156e06
JH
552 break;
553 }
554
43125c69
JH
555 return SR_ERR;
556 }
557
dc9dbe94 558 if (devc->cur_samplerate == 0) {
f92994fd 559 /* Samplerate hasn't been set; default to the slowest one. */
6f4b1868 560 if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
590b9f9a 561 &supported_samplerates[0]) == SR_ERR)
f92994fd
JH
562 return SR_ERR;
563 }
564
f302a082
JH
565 return SR_OK;
566}
567
25a0f108 568static int hw_dev_close(struct sr_dev_inst *sdi)
f302a082 569{
dc9dbe94 570 struct dev_context *devc;
f1898235 571
dc9dbe94
BV
572 devc = sdi->priv;
573 if (devc->usb->devhdl == NULL)
25a0f108 574 return SR_ERR;
f1898235 575
b99457f0 576 sr_info("Closing device %d on %d.%d, interface %d.",
dc9dbe94
BV
577 sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE);
578 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
579 libusb_close(devc->usb->devhdl);
580 devc->usb->devhdl = NULL;
25a0f108 581 sdi->status = SR_ST_INACTIVE;
f1898235 582
f302a082
JH
583 return SR_OK;
584}
585
586static int hw_cleanup(void)
587{
dc9dbe94 588 struct drv_context *drvc;
f69b47f0 589 int ret;
187b3582 590
a873c594 591 if (!(drvc = di->priv))
dc9dbe94
BV
592 return SR_OK;
593
f69b47f0 594 ret = clear_instances();
187b3582 595
dc9dbe94 596 g_free(drvc);
a873c594 597 di->priv = NULL;
187b3582 598
62bc70e4 599 return ret;
f302a082
JH
600}
601
cbd798f4 602static int hw_info_get(int info_id, const void **data,
6e9339aa 603 const struct sr_dev_inst *sdi)
f302a082 604{
dc9dbe94 605 struct dev_context *devc;
8b35f474 606
cbd798f4 607 switch (info_id) {
a27999e6
BV
608 case SR_DI_HWCAPS:
609 *data = hwcaps;
610 break;
8b35f474 611 case SR_DI_NUM_PROBES:
6e9339aa 612 if (sdi) {
dc9dbe94 613 devc = sdi->priv;
6e9339aa 614 *data = GINT_TO_POINTER(
dc9dbe94 615 (devc->profile->dev_caps & DEV_CAPS_16BIT) ?
6e9339aa
BV
616 16 : 8);
617 } else
618 return SR_ERR;
619 break;
8b35f474 620 case SR_DI_PROBE_NAMES:
6e9339aa
BV
621 *data = probe_names;
622 break;
8b35f474 623 case SR_DI_SAMPLERATES:
6e9339aa
BV
624 *data = &samplerates;
625 break;
8b35f474 626 case SR_DI_TRIGGER_TYPES:
6e9339aa
BV
627 *data = TRIGGER_TYPES;
628 break;
e3186647 629 case SR_DI_CUR_SAMPLERATE:
6e9339aa 630 if (sdi) {
dc9dbe94
BV
631 devc = sdi->priv;
632 *data = &devc->cur_samplerate;
6e9339aa
BV
633 } else
634 return SR_ERR;
635 break;
636 default:
637 return SR_ERR_ARG;
8b35f474
JH
638 }
639
6e9339aa 640 return SR_OK;
f302a082
JH
641}
642
6f4b1868
BV
643static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
644 const void *value)
f302a082 645{
dc9dbe94 646 struct dev_context *devc;
7cb621d4
JH
647 int ret;
648
dc9dbe94 649 devc = sdi->priv;
7cb621d4 650
e3186647 651 if (hwcap == SR_HWCAP_SAMPLERATE) {
dc9dbe94 652 devc->cur_samplerate = *(const uint64_t *)value;
e3186647 653 ret = SR_OK;
e3186647 654 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
dc9dbe94 655 devc->limit_samples = *(const uint64_t *)value;
7cb621d4
JH
656 ret = SR_OK;
657 } else {
658 ret = SR_ERR;
659 }
660
661 return ret;
f302a082
JH
662}
663
1f9813eb 664static int receive_data(int fd, int revents, void *cb_data)
610dbb70
JH
665{
666 struct timeval tv;
b99457f0 667 struct drv_context *drvc;
610dbb70 668
610dbb70
JH
669 (void)fd;
670 (void)revents;
1f9813eb 671 (void)cb_data;
610dbb70 672
b99457f0
UH
673 drvc = di->priv;
674
610dbb70 675 tv.tv_sec = tv.tv_usec = 0;
d4abb463 676 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
610dbb70
JH
677
678 return TRUE;
679}
680
dc9dbe94 681static void abort_acquisition(struct dev_context *devc)
cb61e9f7 682{
e7d087bf 683 int i;
0caa1ef0 684
dc9dbe94 685 devc->num_samples = -1;
0caa1ef0 686
dc9dbe94
BV
687 for (i = devc->num_transfers - 1; i >= 0; i--) {
688 if (devc->transfers[i])
689 libusb_cancel_transfer(devc->transfers[i]);
0caa1ef0 690 }
cb61e9f7
JH
691}
692
dc9dbe94 693static void finish_acquisition(struct dev_context *devc)
2e526f4a
JH
694{
695 struct sr_datafeed_packet packet;
a873c594 696 struct drv_context *drvc = di->priv;
b99457f0 697 const struct libusb_pollfd **lupfd;
cb61e9f7 698 int i;
2e526f4a 699
b99457f0 700 /* Terminate session. */
2e526f4a 701 packet.type = SR_DF_END;
dc9dbe94 702 sr_session_send(devc->session_dev_id, &packet);
2e526f4a 703
b99457f0
UH
704 /* Remove fds from polling. */
705 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
cb61e9f7
JH
706 for (i = 0; lupfd[i]; i++)
707 sr_source_remove(lupfd[i]->fd);
708 free(lupfd); /* NOT g_free()! */
0caa1ef0 709
dc9dbe94
BV
710 devc->num_transfers = 0;
711 g_free(devc->transfers);
2e526f4a
JH
712}
713
f855de75
LPC
714static void free_transfer(struct libusb_transfer *transfer)
715{
b99457f0 716 struct dev_context *devc;
0caa1ef0 717 unsigned int i;
f855de75 718
b99457f0
UH
719 devc = transfer->user_data;
720
f855de75
LPC
721 g_free(transfer->buffer);
722 transfer->buffer = NULL;
723 libusb_free_transfer(transfer);
724
dc9dbe94
BV
725 for (i = 0; i < devc->num_transfers; i++) {
726 if (devc->transfers[i] == transfer) {
727 devc->transfers[i] = NULL;
0caa1ef0
LPC
728 break;
729 }
730 }
731
dc9dbe94
BV
732 devc->submitted_transfers--;
733 if (devc->submitted_transfers == 0)
734 finish_acquisition(devc);
f855de75
LPC
735}
736
17dff8a1
LPC
737static void resubmit_transfer(struct libusb_transfer *transfer)
738{
b99457f0 739 int ret;
d4928d71 740
b99457f0 741 if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
d4928d71
PS
742 return;
743
744 free_transfer(transfer);
745 /* TODO: Stop session? */
746
f427daef 747 sr_err("%s: %s", __func__, libusb_error_name(ret));
17dff8a1
LPC
748}
749
610dbb70
JH
750static void receive_transfer(struct libusb_transfer *transfer)
751{
7ce737a7 752 gboolean packet_has_error = FALSE;
610dbb70
JH
753 struct sr_datafeed_packet packet;
754 struct sr_datafeed_logic logic;
b99457f0
UH
755 struct dev_context *devc;
756 int trigger_offset, i, sample_width, cur_sample_count;
757 int trigger_offset_bytes;
758 uint8_t *cur_buf;
759
760 devc = transfer->user_data;
610dbb70 761
610dbb70
JH
762 /*
763 * If acquisition has already ended, just free any queued up
764 * transfer that come in.
765 */
dc9dbe94 766 if (devc->num_samples == -1) {
f855de75 767 free_transfer(transfer);
610dbb70
JH
768 return;
769 }
770
f427daef 771 sr_info("receive_transfer(): status %d received %d bytes.",
610dbb70
JH
772 transfer->status, transfer->actual_length);
773
774 /* Save incoming transfer before reusing the transfer struct. */
b99457f0
UH
775 cur_buf = transfer->buffer;
776 sample_width = devc->sample_wide ? 2 : 1;
777 cur_sample_count = transfer->actual_length / sample_width;
610dbb70 778
7ce737a7
LPC
779 switch (transfer->status) {
780 case LIBUSB_TRANSFER_NO_DEVICE:
dc9dbe94 781 abort_acquisition(devc);
7ce737a7
LPC
782 free_transfer(transfer);
783 return;
784 case LIBUSB_TRANSFER_COMPLETED:
b99457f0 785 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
7ce737a7
LPC
786 break;
787 default:
788 packet_has_error = TRUE;
789 break;
790 }
791
792 if (transfer->actual_length == 0 || packet_has_error) {
dc9dbe94
BV
793 devc->empty_transfer_count++;
794 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
610dbb70
JH
795 /*
796 * The FX2 gave up. End the acquisition, the frontend
797 * will work out that the samplecount is short.
798 */
dc9dbe94 799 abort_acquisition(devc);
17dff8a1
LPC
800 free_transfer(transfer);
801 } else {
802 resubmit_transfer(transfer);
610dbb70
JH
803 }
804 return;
805 } else {
dc9dbe94 806 devc->empty_transfer_count = 0;
610dbb70
JH
807 }
808
6c6781b6 809 trigger_offset = 0;
dc9dbe94 810 if (devc->trigger_stage >= 0) {
d1ddc7a9
JH
811 for (i = 0; i < cur_sample_count; i++) {
812
dc9dbe94 813 const uint16_t cur_sample = devc->sample_wide ?
d1ddc7a9
JH
814 *((const uint16_t*)cur_buf + i) :
815 *((const uint8_t*)cur_buf + i);
6c6781b6 816
dc9dbe94
BV
817 if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) ==
818 devc->trigger_value[devc->trigger_stage]) {
6c6781b6 819 /* Match on this trigger stage. */
dc9dbe94
BV
820 devc->trigger_buffer[devc->trigger_stage] = cur_sample;
821 devc->trigger_stage++;
6c6781b6 822
dc9dbe94
BV
823 if (devc->trigger_stage == NUM_TRIGGER_STAGES ||
824 devc->trigger_mask[devc->trigger_stage] == 0) {
6c6781b6
JH
825 /* Match on all trigger stages, we're done. */
826 trigger_offset = i + 1;
827
828 /*
829 * TODO: Send pre-trigger buffer to session bus.
830 * Tell the frontend we hit the trigger here.
831 */
832 packet.type = SR_DF_TRIGGER;
833 packet.payload = NULL;
dc9dbe94 834 sr_session_send(devc->session_dev_id, &packet);
6c6781b6
JH
835
836 /*
b99457f0
UH
837 * Send the samples that triggered it,
838 * since we're skipping past them.
6c6781b6
JH
839 */
840 packet.type = SR_DF_LOGIC;
841 packet.payload = &logic;
dc9dbe94
BV
842 logic.unitsize = sizeof(*devc->trigger_buffer);
843 logic.length = devc->trigger_stage * logic.unitsize;
844 logic.data = devc->trigger_buffer;
845 sr_session_send(devc->session_dev_id, &packet);
6c6781b6 846
dc9dbe94 847 devc->trigger_stage = TRIGGER_FIRED;
6c6781b6
JH
848 break;
849 }
dc9dbe94 850 } else if (devc->trigger_stage > 0) {
f3ab43a8
LPC
851 /*
852 * We had a match before, but not in the next sample. However, we may
853 * have a match on this stage in the next bit -- trigger on 0001 will
854 * fail on seeing 00001, so we need to go back to stage 0 -- but at
855 * the next sample from the one that matched originally, which the
856 * counter increment at the end of the loop takes care of.
857 */
dc9dbe94 858 i -= devc->trigger_stage;
6c6781b6
JH
859 if (i < -1)
860 i = -1; /* Oops, went back past this buffer. */
861 /* Reset trigger stage. */
dc9dbe94 862 devc->trigger_stage = 0;
6c6781b6
JH
863 }
864 }
865 }
610dbb70 866
dc9dbe94 867 if (devc->trigger_stage == TRIGGER_FIRED) {
6c6781b6 868 /* Send the incoming transfer to the session bus. */
b99457f0 869 trigger_offset_bytes = trigger_offset * sample_width;
6c6781b6
JH
870 packet.type = SR_DF_LOGIC;
871 packet.payload = &logic;
d1ddc7a9
JH
872 logic.length = transfer->actual_length - trigger_offset_bytes;
873 logic.unitsize = sample_width;
874 logic.data = cur_buf + trigger_offset_bytes;
dc9dbe94 875 sr_session_send(devc->session_dev_id, &packet);
6c6781b6 876
dc9dbe94
BV
877 devc->num_samples += cur_sample_count;
878 if (devc->limit_samples &&
879 (unsigned int)devc->num_samples > devc->limit_samples) {
880 abort_acquisition(devc);
0caa1ef0
LPC
881 free_transfer(transfer);
882 return;
6c6781b6
JH
883 }
884 } else {
885 /*
886 * TODO: Buffer pre-trigger data in capture
887 * ratio-sized buffer.
888 */
610dbb70 889 }
17dff8a1
LPC
890
891 resubmit_transfer(transfer);
610dbb70
JH
892}
893
5af666a9
LPC
894static unsigned int to_bytes_per_ms(unsigned int samplerate)
895{
896 return samplerate / 1000;
897}
898
dc9dbe94 899static size_t get_buffer_size(struct dev_context *devc)
5af666a9
LPC
900{
901 size_t s;
902
b99457f0
UH
903 /*
904 * The buffer should be large enough to hold 10ms of data and
905 * a multiple of 512.
906 */
dc9dbe94 907 s = 10 * to_bytes_per_ms(devc->cur_samplerate);
5af666a9
LPC
908 return (s + 511) & ~511;
909}
910
dc9dbe94 911static unsigned int get_number_of_transfers(struct dev_context *devc)
5af666a9
LPC
912{
913 unsigned int n;
914
b99457f0 915 /* Total buffer size should be able to hold about 500ms of data. */
dc9dbe94 916 n = 500 * to_bytes_per_ms(devc->cur_samplerate) / get_buffer_size(devc);
5af666a9
LPC
917
918 if (n > NUM_SIMUL_TRANSFERS)
919 return NUM_SIMUL_TRANSFERS;
920
921 return n;
922}
923
dc9dbe94 924static unsigned int get_timeout(struct dev_context *devc)
5af666a9
LPC
925{
926 size_t total_size;
927 unsigned int timeout;
928
dc9dbe94
BV
929 total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
930 timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
b99457f0 931 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
5af666a9
LPC
932}
933
3ffb6964
BV
934static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
935 void *cb_data)
f302a082 936{
bd47acab
LPC
937 struct sr_datafeed_packet packet;
938 struct sr_datafeed_header header;
f366e86c 939 struct sr_datafeed_meta_logic meta;
dc9dbe94 940 struct dev_context *devc;
b99457f0 941 struct drv_context *drvc;
610dbb70
JH
942 struct libusb_transfer *transfer;
943 const struct libusb_pollfd **lupfd;
b99457f0 944 unsigned int i, timeout, num_transfers;
5af666a9 945 int ret;
610dbb70 946 unsigned char *buf;
b99457f0 947 size_t size;
610dbb70 948
b99457f0 949 drvc = di->priv;
dc9dbe94 950 devc = sdi->priv;
b99457f0 951
dc9dbe94 952 if (devc->submitted_transfers != 0)
c03f0450
LPC
953 return SR_ERR;
954
014359e3 955 if (configure_probes(sdi) != SR_OK) {
b99457f0 956 sr_err("Failed to configure probes.");
014359e3
BV
957 return SR_ERR;
958 }
959
dc9dbe94
BV
960 devc->session_dev_id = cb_data;
961 devc->num_samples = 0;
962 devc->empty_transfer_count = 0;
610dbb70 963
b99457f0
UH
964 timeout = get_timeout(devc);
965 num_transfers = get_number_of_transfers(devc);
966 size = get_buffer_size(devc);
5af666a9 967
dc9dbe94 968 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
886a52b6 969 if (!devc->transfers) {
f427daef 970 sr_err("USB transfers malloc failed.");
886a52b6
UH
971 return SR_ERR_MALLOC;
972 }
0caa1ef0 973
dc9dbe94 974 devc->num_transfers = num_transfers;
0caa1ef0 975
5af666a9 976 for (i = 0; i < num_transfers; i++) {
610dbb70 977 if (!(buf = g_try_malloc(size))) {
b99457f0 978 sr_err("USB transfer buffer malloc failed.");
610dbb70
JH
979 return SR_ERR_MALLOC;
980 }
981 transfer = libusb_alloc_transfer(0);
dc9dbe94 982 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
610dbb70 983 2 | LIBUSB_ENDPOINT_IN, buf, size,
dc9dbe94 984 receive_transfer, devc, timeout);
d4928d71 985 if ((ret = libusb_submit_transfer(transfer)) != 0) {
b99457f0
UH
986 sr_err("Failed to submit transfer: %s.",
987 libusb_error_name(ret));
610dbb70
JH
988 libusb_free_transfer(transfer);
989 g_free(buf);
dc9dbe94 990 abort_acquisition(devc);
610dbb70
JH
991 return SR_ERR;
992 }
dc9dbe94
BV
993 devc->transfers[i] = transfer;
994 devc->submitted_transfers++;
610dbb70
JH
995 }
996
d4abb463 997 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
610dbb70
JH
998 for (i = 0; lupfd[i]; i++)
999 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
5af666a9 1000 timeout, receive_data, NULL);
610dbb70
JH
1001 free(lupfd); /* NOT g_free()! */
1002
bd47acab
LPC
1003 packet.type = SR_DF_HEADER;
1004 packet.payload = &header;
1005 header.feed_version = 1;
1006 gettimeofday(&header.starttime, NULL);
1007 sr_session_send(cb_data, &packet);
f366e86c
BV
1008
1009 /* Send metadata about the SR_DF_LOGIC packets to come. */
bd47acab
LPC
1010 packet.type = SR_DF_META_LOGIC;
1011 packet.payload = &meta;
dc9dbe94
BV
1012 meta.samplerate = devc->cur_samplerate;
1013 meta.num_probes = devc->sample_wide ? 16 : 8;
bd47acab 1014 sr_session_send(cb_data, &packet);
610dbb70 1015
b99457f0 1016 if ((ret = command_start_acquisition(devc->usb->devhdl,
dc9dbe94
BV
1017 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1018 abort_acquisition(devc);
ebc34738 1019 return ret;
017375d1
JH
1020 }
1021
f302a082
JH
1022 return SR_OK;
1023}
1024
3cd3a20b 1025/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
69b07d14 1026static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
f302a082 1027{
2e526f4a 1028 (void)cb_data;
5da93902 1029
2e526f4a 1030 abort_acquisition(sdi->priv);
5da93902 1031
f302a082
JH
1032 return SR_OK;
1033}
1034
c09f0b57 1035SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
f302a082 1036 .name = "fx2lafw",
2e7cb004 1037 .longname = "fx2lafw (generic driver for FX2 based LAs)",
f302a082
JH
1038 .api_version = 1,
1039 .init = hw_init,
1040 .cleanup = hw_cleanup,
61136ea6 1041 .scan = hw_scan,
811deee4
BV
1042 .dev_list = hw_dev_list,
1043 .dev_clear = clear_instances,
f302a082
JH
1044 .dev_open = hw_dev_open,
1045 .dev_close = hw_dev_close,
6e9339aa 1046 .info_get = hw_info_get,
f302a082
JH
1047 .dev_config_set = hw_dev_config_set,
1048 .dev_acquisition_start = hw_dev_acquisition_start,
1049 .dev_acquisition_stop = hw_dev_acquisition_stop,
dc9dbe94 1050 .priv = NULL,
f302a082 1051};