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