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