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