]> sigrok.org Git - libsigrok.git/blame - hardware/fx2lafw/fx2lafw.c
sr: remove unused argument from hardware driver function init()
[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>
f302a082 26#include "config.h"
45c59c8b
BV
27#include "libsigrok.h"
28#include "libsigrok-internal.h"
f302a082 29#include "fx2lafw.h"
f6582cd7 30#include "command.h"
f302a082 31
4679d14d 32static const struct fx2lafw_profile supported_fx2[] = {
7ae2f9d5
UH
33 /*
34 * CWAV USBee AX
17b6c75a 35 * EE Electronics ESLA201A
9f05304e 36 * ARMFLY AX-Pro
17b6c75a 37 */
f8b07fc6 38 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
d1ddc7a9
JH
39 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
40 0 },
0e8d0e24
IF
41 /*
42 * CWAV USBee DX
43 * XZL-Studio DX
44 */
45 { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
46 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
47 DEV_CAPS_16BIT },
93a9f3da 48
7ae2f9d5
UH
49 /*
50 * CWAV USBee SX
4502e869
JH
51 */
52 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
d1ddc7a9
JH
53 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
54 0 },
4502e869 55
7ae2f9d5
UH
56 /*
57 * Saleae Logic
93a9f3da
JH
58 * EE Electronics ESLA100
59 * Robomotic MiniLogic
1663e470 60 * Robomotic BugLogic 3
93a9f3da
JH
61 */
62 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
d1ddc7a9
JH
63 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
64 0 },
93a9f3da 65
f488762a 66 /*
1663e470
UH
67 * Default Cypress FX2 without EEPROM, e.g.:
68 * Lcsoft Mini Board
69 * Braintechnology USB Interface V2.x
f488762a
JH
70 */
71 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
d1ddc7a9
JH
72 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
73 DEV_CAPS_16BIT },
f488762a 74
1663e470
UH
75 /*
76 * Braintechnology USB-LPS
77 */
78 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
d1ddc7a9
JH
79 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
80 DEV_CAPS_16BIT },
1663e470 81
f8b07fc6 82 { 0, 0, 0, 0, 0, 0, 0 }
187b3582
JH
83};
84
915f7cc8 85static const int hwcaps[] = {
8b35f474
JH
86 SR_HWCAP_LOGIC_ANALYZER,
87 SR_HWCAP_SAMPLERATE,
88
89 /* These are really implemented in the driver, not the hardware. */
90 SR_HWCAP_LIMIT_SAMPLES,
91 SR_HWCAP_CONTINUOUS,
772a0e61 92 0,
8b35f474
JH
93};
94
da686568
UH
95/*
96 * TODO: Different probe_names[] for each supported device.
97 */
98static const char *probe_names[] = {
7ae2f9d5
UH
99 "0",
100 "1",
101 "2",
102 "3",
103 "4",
104 "5",
105 "6",
106 "7",
d1ddc7a9
JH
107 "8",
108 "9",
109 "10",
110 "11",
111 "12",
112 "13",
113 "14",
114 "15",
772a0e61 115 NULL,
8b35f474
JH
116};
117
a533743d 118static const uint64_t supported_samplerates[] = {
79dc6498
JH
119 SR_KHZ(20),
120 SR_KHZ(25),
897c1a2e
JH
121 SR_KHZ(50),
122 SR_KHZ(100),
9304d576
JH
123 SR_KHZ(200),
124 SR_KHZ(250),
125 SR_KHZ(500),
8b35f474
JH
126 SR_MHZ(1),
127 SR_MHZ(2),
128 SR_MHZ(3),
129 SR_MHZ(4),
130 SR_MHZ(6),
131 SR_MHZ(8),
132 SR_MHZ(12),
133 SR_MHZ(16),
772a0e61 134 SR_MHZ(24),
934cde02 135 0,
8b35f474
JH
136};
137
a533743d 138static const struct sr_samplerates samplerates = {
590b9f9a
UH
139 0,
140 0,
141 0,
142 supported_samplerates,
8b35f474
JH
143};
144
cac0bbaa 145static GSList *dev_insts = NULL;
187b3582
JH
146static libusb_context *usb_context = NULL;
147
1b79df2f 148static int hw_dev_config_set(int dev_index, int hwcap, const void *value);
da686568 149static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
610dbb70 150
b1eeb67e
JH
151/**
152 * Check the USB configuration to determine if this is an fx2lafw device.
153 *
f9a69557
UH
154 * @return TRUE if the device's configuration profile match fx2lafw
155 * configuration, FALSE otherwise.
b1eeb67e 156 */
f9a69557 157static gboolean check_conf_profile(libusb_device *dev)
b1eeb67e
JH
158{
159 struct libusb_device_descriptor des;
6b73d9a5
BV
160 struct libusb_device_handle *hdl;
161 gboolean ret;
162 unsigned char strdesc[64];
b1eeb67e 163
6b73d9a5
BV
164 hdl = NULL;
165 ret = FALSE;
b1eeb67e 166 while (!ret) {
da686568 167 /* Assume the FW has not been loaded, unless proven wrong. */
b1eeb67e
JH
168 if (libusb_get_device_descriptor(dev, &des) != 0)
169 break;
170
6b73d9a5 171 if (libusb_open(dev, &hdl) != 0)
b1eeb67e
JH
172 break;
173
6b73d9a5
BV
174 if (libusb_get_string_descriptor_ascii(hdl,
175 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
b1eeb67e 176 break;
6b73d9a5 177 if (strncmp((const char *)strdesc, "sigrok", 6))
b1eeb67e
JH
178 break;
179
6b73d9a5
BV
180 if (libusb_get_string_descriptor_ascii(hdl,
181 des.iProduct, strdesc, sizeof(strdesc)) < 0)
b1eeb67e 182 break;
6b73d9a5 183 if (strncmp((const char *)strdesc, "fx2lafw", 7))
b1eeb67e
JH
184 break;
185
b1eeb67e 186 /* If we made it here, it must be an fx2lafw. */
f9a69557 187 ret = TRUE;
b1eeb67e 188 }
6b73d9a5
BV
189 if (hdl)
190 libusb_close(hdl);
b1eeb67e
JH
191
192 return ret;
193}
194
da686568 195static int fx2lafw_dev_open(int dev_index)
43125c69
JH
196{
197 libusb_device **devlist;
198 struct libusb_device_descriptor des;
199 struct sr_dev_inst *sdi;
772a0e61 200 struct context *ctx;
13bf7ecc 201 struct version_info vi;
ebc34738 202 int ret, skip, i;
1e94408a 203 uint8_t revid;
43125c69
JH
204
205 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
206 return SR_ERR;
207 ctx = sdi->priv;
208
209 if (sdi->status == SR_ST_ACTIVE)
210 /* already in use */
211 return SR_ERR;
212
213 skip = 0;
6fbe5e60
JH
214 const int device_count = libusb_get_device_list(usb_context, &devlist);
215 if (device_count < 0) {
216 sr_err("fx2lafw: Failed to retrieve device list (%d)",
217 device_count);
218 return SR_ERR;
219 }
220
221 for (i = 0; i < device_count; i++) {
ebc34738 222 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
7ae2f9d5
UH
223 sr_err("fx2lafw: Failed to get device descriptor: %d.",
224 ret);
43125c69
JH
225 continue;
226 }
227
74fcfb80
JH
228 if (des.idVendor != ctx->profile->vid
229 || des.idProduct != ctx->profile->pid)
43125c69
JH
230 continue;
231
232 if (sdi->status == SR_ST_INITIALIZING) {
233 if (skip != dev_index) {
234 /* Skip devices of this type that aren't the one we want. */
235 skip += 1;
236 continue;
237 }
238 } else if (sdi->status == SR_ST_INACTIVE) {
239 /*
240 * This device is fully enumerated, so we need to find
241 * this device by vendor, product, bus and address.
242 */
243 if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
244 || libusb_get_device_address(devlist[i]) != ctx->usb->address)
245 /* this is not the one */
246 continue;
247 }
248
ebc34738 249 if (!(ret = libusb_open(devlist[i], &ctx->usb->devhdl))) {
43125c69
JH
250 if (ctx->usb->address == 0xff)
251 /*
252 * first time we touch this device after firmware upload,
253 * so we don't know the address yet.
254 */
255 ctx->usb->address = libusb_get_device_address(devlist[i]);
43125c69 256 } else {
7ae2f9d5 257 sr_err("fx2lafw: Failed to open device: %d.", ret);
13bf7ecc
JH
258 break;
259 }
260
44dfd483
UH
261 ret = command_get_fw_version(ctx->usb->devhdl, &vi);
262 if (ret != SR_OK) {
13bf7ecc 263 sr_err("fx2lafw: Failed to retrieve "
44dfd483 264 "firmware version information.");
13bf7ecc 265 break;
43125c69
JH
266 }
267
1e94408a
UH
268 ret = command_get_revid_version(ctx->usb->devhdl, &revid);
269 if (ret != SR_OK) {
270 sr_err("fx2lafw: Failed to retrieve REVID.");
271 break;
272 }
273
0a8c0c32
UH
274 /*
275 * Changes in major version mean incompatible/API changes, so
276 * bail out if we encounter an incompatible version.
277 * Different minor versions are OK, they should be compatible.
278 */
279 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
280 sr_err("fx2lafw: Expected firmware version %d.x, "
281 "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
282 vi.major, vi.minor);
13bf7ecc
JH
283 break;
284 }
285
286 sdi->status = SR_ST_ACTIVE;
287 sr_info("fx2lafw: Opened device %d on %d.%d "
1e94408a 288 "interface %d, firmware %d.%d, REVID %d.",
13bf7ecc 289 sdi->index, ctx->usb->bus, ctx->usb->address,
1e94408a 290 USB_INTERFACE, vi.major, vi.minor, revid);
13bf7ecc 291
43125c69
JH
292 break;
293 }
294 libusb_free_device_list(devlist, 1);
295
296 if (sdi->status != SR_ST_ACTIVE)
297 return SR_ERR;
298
299 return SR_OK;
300}
301
f1898235
JH
302static void close_dev(struct sr_dev_inst *sdi)
303{
772a0e61 304 struct context *ctx;
f1898235
JH
305
306 ctx = sdi->priv;
307
308 if (ctx->usb->devhdl == NULL)
309 return;
310
7ae2f9d5
UH
311 sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
312 sdi->index, ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
f1898235
JH
313 libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
314 libusb_close(ctx->usb->devhdl);
315 ctx->usb->devhdl = NULL;
316 sdi->status = SR_ST_INACTIVE;
317}
318
6c6781b6
JH
319static int configure_probes(struct context *ctx, GSList *probes)
320{
321 struct sr_probe *probe;
322 GSList *l;
323 int probe_bit, stage, i;
324 char *tc;
325
326 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
327 ctx->trigger_mask[i] = 0;
328 ctx->trigger_value[i] = 0;
329 }
330
331 stage = -1;
332 for (l = probes; l; l = l->next) {
333 probe = (struct sr_probe *)l->data;
334 if (probe->enabled == FALSE)
335 continue;
d1ddc7a9
JH
336
337 if (probe->index > 8)
0a88ec3d 338 ctx->sample_wide = TRUE;
d1ddc7a9 339
6c6781b6
JH
340 probe_bit = 1 << (probe->index - 1);
341 if (!(probe->trigger))
342 continue;
343
344 stage = 0;
345 for (tc = probe->trigger; *tc; tc++) {
346 ctx->trigger_mask[stage] |= probe_bit;
347 if (*tc == '1')
348 ctx->trigger_value[stage] |= probe_bit;
349 stage++;
350 if (stage > NUM_TRIGGER_STAGES)
351 return SR_ERR;
352 }
353 }
354
355 if (stage == -1)
356 /*
357 * We didn't configure any triggers, make sure acquisition
358 * doesn't wait for any.
359 */
360 ctx->trigger_stage = TRIGGER_FIRED;
361 else
362 ctx->trigger_stage = 0;
363
364 return SR_OK;
365}
366
da686568 367static struct context *fx2lafw_dev_new(void)
187b3582 368{
772a0e61 369 struct context *ctx;
187b3582 370
772a0e61 371 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
7ae2f9d5 372 sr_err("fx2lafw: %s: ctx malloc failed.", __func__);
187b3582
JH
373 return NULL;
374 }
375
6c6781b6
JH
376 ctx->trigger_stage = TRIGGER_FIRED;
377
772a0e61 378 return ctx;
187b3582 379}
f302a082
JH
380
381/*
382 * API callbacks
383 */
384
40dda2c3 385static int hw_init(void)
f302a082 386{
187b3582
JH
387 struct sr_dev_inst *sdi;
388 struct libusb_device_descriptor des;
da686568 389 const struct fx2lafw_profile *prof;
772a0e61 390 struct context *ctx;
187b3582 391 libusb_device **devlist;
ebc34738 392 int ret;
187b3582
JH
393 int devcnt = 0;
394 int i, j;
395
187b3582 396 if (libusb_init(&usb_context) != 0) {
7ae2f9d5 397 sr_warn("fx2lafw: Failed to initialize libusb.");
187b3582
JH
398 return 0;
399 }
400
921634ec 401 /* Find all fx2lafw compatible devices and upload firmware to them. */
187b3582
JH
402 libusb_get_device_list(usb_context, &devlist);
403 for (i = 0; devlist[i]; i++) {
404
ebc34738 405 if ((ret = libusb_get_device_descriptor(
7ae2f9d5
UH
406 devlist[i], &des)) != 0) {
407 sr_warn("fx2lafw: Failed to get device descriptor: %d.", ret);
187b3582
JH
408 continue;
409 }
410
da686568 411 prof = NULL;
187b3582
JH
412 for (j = 0; supported_fx2[j].vid; j++) {
413 if (des.idVendor == supported_fx2[j].vid &&
414 des.idProduct == supported_fx2[j].pid) {
da686568 415 prof = &supported_fx2[j];
187b3582
JH
416 }
417 }
418
419 /* Skip if the device was not found */
da686568 420 if (!prof)
187b3582
JH
421 continue;
422
423 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
da686568 424 prof->vendor, prof->model, prof->model_version);
f4a9e5c0 425 if (!sdi)
187b3582
JH
426 return 0;
427
da686568
UH
428 ctx = fx2lafw_dev_new();
429 ctx->profile = prof;
90282c82 430 sdi->priv = ctx;
be4b99e8 431 dev_insts = g_slist_append(dev_insts, sdi);
187b3582 432
b1eeb67e
JH
433 if (check_conf_profile(devlist[i])) {
434 /* Already has the firmware, so fix the new address. */
7ae2f9d5 435 sr_dbg("fx2lafw: Found an fx2lafw device.");
b1eeb67e
JH
436 sdi->status = SR_ST_INACTIVE;
437 ctx->usb = sr_usb_dev_inst_new
438 (libusb_get_bus_number(devlist[i]),
439 libusb_get_device_address(devlist[i]), NULL);
440 } else {
f8b07fc6 441 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
da686568 442 prof->firmware) == SR_OK)
b1eeb67e 443 /* Remember when the firmware on this device was updated */
e8bd58ff 444 ctx->fw_updated = g_get_monotonic_time();
b1eeb67e 445 else
7ae2f9d5
UH
446 sr_err("fx2lafw: Firmware upload failed for "
447 "device %d.", devcnt);
b1eeb67e
JH
448 ctx->usb = sr_usb_dev_inst_new
449 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
450 }
451
187b3582
JH
452 devcnt++;
453 }
454 libusb_free_device_list(devlist, 1);
455
456 return devcnt;
f302a082
JH
457}
458
772a0e61 459static int hw_dev_open(int dev_index)
f302a082 460{
43125c69 461 struct sr_dev_inst *sdi;
772a0e61 462 struct context *ctx;
e8bd58ff
UH
463 int ret;
464 int64_t timediff_us, timediff_ms;
43125c69 465
772a0e61 466 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
43125c69
JH
467 return SR_ERR;
468 ctx = sdi->priv;
469
470 /*
f60fdf6e
UH
471 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
472 * milliseconds for the FX2 to renumerate.
43125c69 473 */
3b6c1930 474 ret = SR_ERR;
e8bd58ff 475 if (ctx->fw_updated > 0) {
7ae2f9d5 476 sr_info("fx2lafw: Waiting for device to reset.");
43125c69
JH
477 /* takes at least 300ms for the FX2 to be gone from the USB bus */
478 g_usleep(300 * 1000);
e8bd58ff 479 timediff_ms = 0;
f60fdf6e 480 while (timediff_ms < MAX_RENUM_DELAY_MS) {
da686568 481 if ((ret = fx2lafw_dev_open(dev_index)) == SR_OK)
43125c69
JH
482 break;
483 g_usleep(100 * 1000);
e8bd58ff
UH
484
485 timediff_us = g_get_monotonic_time() - ctx->fw_updated;
3b6c1930
BV
486 timediff_ms = timediff_us / 1000;
487 sr_spew("fx2lafw: waited %" PRIi64 " ms", timediff_ms);
43125c69 488 }
e8bd58ff 489 sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
43125c69 490 } else {
da686568 491 ret = fx2lafw_dev_open(dev_index);
43125c69
JH
492 }
493
ebc34738 494 if (ret != SR_OK) {
7ae2f9d5 495 sr_err("fx2lafw: Unable to open device.");
43125c69
JH
496 return SR_ERR;
497 }
498 ctx = sdi->priv;
499
ebc34738
UH
500 ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
501 if (ret != 0) {
0c156e06
JH
502 switch(ret) {
503 case LIBUSB_ERROR_BUSY:
504 sr_err("fx2lafw: Unable to claim USB interface. Another "
505 "program or driver has already claimed it.");
506 break;
507
508 case LIBUSB_ERROR_NO_DEVICE:
509 sr_err("fx2lafw: Device has been disconnected.");
510 break;
511
512 default:
513 sr_err("fx2lafw: Unable to claim interface: %d.", ret);
514 break;
515 }
516
43125c69
JH
517 return SR_ERR;
518 }
519
f92994fd
JH
520 if (ctx->cur_samplerate == 0) {
521 /* Samplerate hasn't been set; default to the slowest one. */
522 if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE,
590b9f9a 523 &supported_samplerates[0]) == SR_ERR)
f92994fd
JH
524 return SR_ERR;
525 }
526
f302a082
JH
527 return SR_OK;
528}
529
f1898235 530static int hw_dev_close(int dev_index)
f302a082 531{
f1898235
JH
532 struct sr_dev_inst *sdi;
533
534 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
7ae2f9d5 535 sr_err("fx2lafw: %s: sdi was NULL.", __func__);
0abee507 536 return SR_ERR_BUG;
f1898235
JH
537 }
538
539 /* TODO */
540 close_dev(sdi);
541
f302a082
JH
542 return SR_OK;
543}
544
545static int hw_cleanup(void)
546{
187b3582
JH
547 GSList *l;
548 struct sr_dev_inst *sdi;
772a0e61 549 struct context *ctx;
62bc70e4 550 int ret = SR_OK;
187b3582 551
f4a9e5c0 552 for (l = dev_insts; l; l = l->next) {
62bc70e4
JH
553 if (!(sdi = l->data)) {
554 /* Log error, but continue cleaning up the rest. */
7ae2f9d5
UH
555 sr_err("fx2lafw: %s: sdi was NULL, continuing.",
556 __func__);
62bc70e4
JH
557 ret = SR_ERR_BUG;
558 continue;
559 }
560 if (!(ctx = sdi->priv)) {
561 /* Log error, but continue cleaning up the rest. */
562 sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
563 __func__);
564 ret = SR_ERR_BUG;
565 continue;
566 }
567 close_dev(sdi);
187b3582
JH
568 sdi = l->data;
569 sr_dev_inst_free(sdi);
570 }
571
62bc70e4
JH
572 g_slist_free(dev_insts);
573 dev_insts = NULL;
187b3582 574
f4a9e5c0 575 if (usb_context)
187b3582
JH
576 libusb_exit(usb_context);
577 usb_context = NULL;
578
62bc70e4 579 return ret;
f302a082
JH
580}
581
b7f578be 582static const void *hw_dev_info_get(int dev_index, int dev_info_id)
f302a082 583{
8b35f474 584 struct sr_dev_inst *sdi;
772a0e61 585 struct context *ctx;
8b35f474 586
772a0e61 587 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
8b35f474 588 return NULL;
cdfdd711 589 ctx = sdi->priv;
8b35f474 590
772a0e61 591 switch (dev_info_id) {
8b35f474
JH
592 case SR_DI_INST:
593 return sdi;
594 case SR_DI_NUM_PROBES:
d1ddc7a9
JH
595 return GINT_TO_POINTER(
596 (ctx->profile->dev_caps & DEV_CAPS_16BIT) ?
597 16 : 8);
8b35f474 598 case SR_DI_PROBE_NAMES:
da686568 599 return probe_names;
8b35f474 600 case SR_DI_SAMPLERATES:
590b9f9a 601 return &samplerates;
8b35f474
JH
602 case SR_DI_TRIGGER_TYPES:
603 return TRIGGER_TYPES;
e3186647
JH
604 case SR_DI_CUR_SAMPLERATE:
605 return &ctx->cur_samplerate;
8b35f474
JH
606 }
607
f302a082
JH
608 return NULL;
609}
610
772a0e61 611static int hw_dev_status_get(int dev_index)
f302a082 612{
aae2fed6 613 const struct sr_dev_inst *const sdi =
772a0e61 614 sr_dev_inst_get(dev_insts, dev_index);
aae2fed6
JH
615
616 if (!sdi)
617 return SR_ST_NOT_FOUND;
618
619 return sdi->status;
f302a082
JH
620}
621
915f7cc8 622static const int *hw_hwcap_get_all(void)
f302a082 623{
da686568 624 return hwcaps;
f302a082
JH
625}
626
1b79df2f 627static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
f302a082 628{
7cb621d4 629 struct sr_dev_inst *sdi;
772a0e61 630 struct context *ctx;
7cb621d4
JH
631 int ret;
632
633 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
634 return SR_ERR;
635 ctx = sdi->priv;
636
e3186647 637 if (hwcap == SR_HWCAP_SAMPLERATE) {
1b79df2f 638 ctx->cur_samplerate = *(const uint64_t *)value;
e3186647
JH
639 ret = SR_OK;
640 } else if (hwcap == SR_HWCAP_PROBECONFIG) {
6c6781b6 641 ret = configure_probes(ctx, (GSList *) value);
e3186647 642 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
1b79df2f 643 ctx->limit_samples = *(const uint64_t *)value;
7cb621d4
JH
644 ret = SR_OK;
645 } else {
646 ret = SR_ERR;
647 }
648
649 return ret;
f302a082
JH
650}
651
1f9813eb 652static int receive_data(int fd, int revents, void *cb_data)
610dbb70
JH
653{
654 struct timeval tv;
655
656 /* Avoid compiler warnings. */
657 (void)fd;
658 (void)revents;
1f9813eb 659 (void)cb_data;
610dbb70
JH
660
661 tv.tv_sec = tv.tv_usec = 0;
662 libusb_handle_events_timeout(usb_context, &tv);
663
664 return TRUE;
665}
666
2e526f4a 667static void abort_acquisition(struct context *ctx)
cb61e9f7 668{
e7d087bf 669 int i;
0caa1ef0 670
cb61e9f7 671 ctx->num_samples = -1;
0caa1ef0 672
e7d087bf 673 for (i = ctx->num_transfers - 1; i >= 0; i--) {
0caa1ef0
LPC
674 if (ctx->transfers[i])
675 libusb_cancel_transfer(ctx->transfers[i]);
676 }
cb61e9f7
JH
677}
678
3e6292b2 679static void finish_acquisition(struct context *ctx)
2e526f4a
JH
680{
681 struct sr_datafeed_packet packet;
cb61e9f7 682 int i;
2e526f4a 683
cb61e9f7 684 /* Terminate session */
2e526f4a
JH
685 packet.type = SR_DF_END;
686 sr_session_send(ctx->session_dev_id, &packet);
687
cb61e9f7
JH
688 /* Remove fds from polling */
689 const struct libusb_pollfd **const lupfd =
690 libusb_get_pollfds(usb_context);
691 for (i = 0; lupfd[i]; i++)
692 sr_source_remove(lupfd[i]->fd);
693 free(lupfd); /* NOT g_free()! */
0caa1ef0
LPC
694
695 ctx->num_transfers = 0;
696 g_free(ctx->transfers);
2e526f4a
JH
697}
698
f855de75
LPC
699static void free_transfer(struct libusb_transfer *transfer)
700{
701 struct context *ctx = transfer->user_data;
0caa1ef0 702 unsigned int i;
f855de75
LPC
703
704 g_free(transfer->buffer);
705 transfer->buffer = NULL;
706 libusb_free_transfer(transfer);
707
0caa1ef0
LPC
708 for (i = 0; i < ctx->num_transfers; i++) {
709 if (ctx->transfers[i] == transfer) {
710 ctx->transfers[i] = NULL;
711 break;
712 }
713 }
714
f855de75
LPC
715 ctx->submitted_transfers--;
716 if (ctx->submitted_transfers == 0)
717 finish_acquisition(ctx);
718
719}
720
17dff8a1
LPC
721static void resubmit_transfer(struct libusb_transfer *transfer)
722{
17dff8a1
LPC
723 if (libusb_submit_transfer(transfer) != 0) {
724 free_transfer(transfer);
725 /* TODO: Stop session? */
726 /* TODO: Better error message. */
727 sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
728 }
729}
730
610dbb70
JH
731static void receive_transfer(struct libusb_transfer *transfer)
732{
7ce737a7 733 gboolean packet_has_error = FALSE;
610dbb70
JH
734 struct sr_datafeed_packet packet;
735 struct sr_datafeed_logic logic;
2e526f4a 736 struct context *ctx = transfer->user_data;
d1ddc7a9 737 int trigger_offset, i;
610dbb70 738
610dbb70
JH
739 /*
740 * If acquisition has already ended, just free any queued up
741 * transfer that come in.
742 */
2e526f4a 743 if (ctx->num_samples == -1) {
f855de75 744 free_transfer(transfer);
610dbb70
JH
745 return;
746 }
747
7ae2f9d5 748 sr_info("fx2lafw: receive_transfer(): status %d received %d bytes.",
610dbb70
JH
749 transfer->status, transfer->actual_length);
750
751 /* Save incoming transfer before reusing the transfer struct. */
d1ddc7a9
JH
752 uint8_t *const cur_buf = transfer->buffer;
753 const int sample_width = ctx->sample_wide ? 2 : 1;
754 const int cur_sample_count = transfer->actual_length / sample_width;
610dbb70 755
7ce737a7
LPC
756 switch (transfer->status) {
757 case LIBUSB_TRANSFER_NO_DEVICE:
758 abort_acquisition(ctx);
759 free_transfer(transfer);
760 return;
761 case LIBUSB_TRANSFER_COMPLETED:
762 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */
763 break;
764 default:
765 packet_has_error = TRUE;
766 break;
767 }
768
769 if (transfer->actual_length == 0 || packet_has_error) {
2769eed9
LPC
770 ctx->empty_transfer_count++;
771 if (ctx->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
610dbb70
JH
772 /*
773 * The FX2 gave up. End the acquisition, the frontend
774 * will work out that the samplecount is short.
775 */
2e526f4a 776 abort_acquisition(ctx);
17dff8a1
LPC
777 free_transfer(transfer);
778 } else {
779 resubmit_transfer(transfer);
610dbb70
JH
780 }
781 return;
782 } else {
2769eed9 783 ctx->empty_transfer_count = 0;
610dbb70
JH
784 }
785
6c6781b6
JH
786 trigger_offset = 0;
787 if (ctx->trigger_stage >= 0) {
d1ddc7a9
JH
788 for (i = 0; i < cur_sample_count; i++) {
789
790 const uint16_t cur_sample = ctx->sample_wide ?
791 *((const uint16_t*)cur_buf + i) :
792 *((const uint8_t*)cur_buf + i);
6c6781b6 793
d1ddc7a9
JH
794 if ((cur_sample & ctx->trigger_mask[ctx->trigger_stage]) ==
795 ctx->trigger_value[ctx->trigger_stage]) {
6c6781b6 796 /* Match on this trigger stage. */
d1ddc7a9 797 ctx->trigger_buffer[ctx->trigger_stage] = cur_sample;
6c6781b6
JH
798 ctx->trigger_stage++;
799
d1ddc7a9
JH
800 if (ctx->trigger_stage == NUM_TRIGGER_STAGES ||
801 ctx->trigger_mask[ctx->trigger_stage] == 0) {
6c6781b6
JH
802 /* Match on all trigger stages, we're done. */
803 trigger_offset = i + 1;
804
805 /*
806 * TODO: Send pre-trigger buffer to session bus.
807 * Tell the frontend we hit the trigger here.
808 */
809 packet.type = SR_DF_TRIGGER;
810 packet.payload = NULL;
811 sr_session_send(ctx->session_dev_id, &packet);
812
813 /*
814 * Send the samples that triggered it, since we're
815 * skipping past them.
816 */
817 packet.type = SR_DF_LOGIC;
818 packet.payload = &logic;
fa114e4a
LPC
819 logic.unitsize = sizeof(*ctx->trigger_buffer);
820 logic.length = ctx->trigger_stage * logic.unitsize;
6c6781b6
JH
821 logic.data = ctx->trigger_buffer;
822 sr_session_send(ctx->session_dev_id, &packet);
823
824 ctx->trigger_stage = TRIGGER_FIRED;
825 break;
826 }
f3ab43a8
LPC
827 } else if (ctx->trigger_stage > 0) {
828 /*
829 * We had a match before, but not in the next sample. However, we may
830 * have a match on this stage in the next bit -- trigger on 0001 will
831 * fail on seeing 00001, so we need to go back to stage 0 -- but at
832 * the next sample from the one that matched originally, which the
833 * counter increment at the end of the loop takes care of.
834 */
6c6781b6
JH
835 i -= ctx->trigger_stage;
836 if (i < -1)
837 i = -1; /* Oops, went back past this buffer. */
838 /* Reset trigger stage. */
839 ctx->trigger_stage = 0;
840 }
841 }
842 }
610dbb70 843
6c6781b6
JH
844 if (ctx->trigger_stage == TRIGGER_FIRED) {
845 /* Send the incoming transfer to the session bus. */
0a88ec3d 846 const int trigger_offset_bytes = trigger_offset * sample_width;
6c6781b6
JH
847 packet.type = SR_DF_LOGIC;
848 packet.payload = &logic;
d1ddc7a9
JH
849 logic.length = transfer->actual_length - trigger_offset_bytes;
850 logic.unitsize = sample_width;
851 logic.data = cur_buf + trigger_offset_bytes;
6c6781b6 852 sr_session_send(ctx->session_dev_id, &packet);
6c6781b6 853
d1ddc7a9 854 ctx->num_samples += cur_sample_count;
6c6781b6
JH
855 if (ctx->limit_samples &&
856 (unsigned int)ctx->num_samples > ctx->limit_samples) {
857 abort_acquisition(ctx);
0caa1ef0
LPC
858 free_transfer(transfer);
859 return;
6c6781b6
JH
860 }
861 } else {
862 /*
863 * TODO: Buffer pre-trigger data in capture
864 * ratio-sized buffer.
865 */
610dbb70 866 }
17dff8a1
LPC
867
868 resubmit_transfer(transfer);
610dbb70
JH
869}
870
5af666a9
LPC
871static unsigned int to_bytes_per_ms(unsigned int samplerate)
872{
873 return samplerate / 1000;
874}
875
876static size_t get_buffer_size(struct context *ctx)
877{
878 size_t s;
879
880 /* The buffer should be large enough to hold 10ms of data and a multiple
881 * of 512. */
882 s = 10 * to_bytes_per_ms(ctx->cur_samplerate);
883 return (s + 511) & ~511;
884}
885
886static unsigned int get_number_of_transfers(struct context *ctx)
887{
888 unsigned int n;
889
890 /* Total buffer size should be able to hold about 500ms of data */
891 n = 500 * to_bytes_per_ms(ctx->cur_samplerate) / get_buffer_size(ctx);
892
893 if (n > NUM_SIMUL_TRANSFERS)
894 return NUM_SIMUL_TRANSFERS;
895
896 return n;
897}
898
899static unsigned int get_timeout(struct context *ctx)
900{
901 size_t total_size;
902 unsigned int timeout;
903
904 total_size = get_buffer_size(ctx) * get_number_of_transfers(ctx);
905 timeout = total_size / to_bytes_per_ms(ctx->cur_samplerate);
906 return timeout + timeout / 4; /* Leave a headroom of 25% percent */
907}
908
3cd3a20b 909static int hw_dev_acquisition_start(int dev_index, void *cb_data)
f302a082 910{
610dbb70 911 struct sr_dev_inst *sdi;
bd47acab
LPC
912 struct sr_datafeed_packet packet;
913 struct sr_datafeed_header header;
f366e86c 914 struct sr_datafeed_meta_logic meta;
772a0e61 915 struct context *ctx;
610dbb70
JH
916 struct libusb_transfer *transfer;
917 const struct libusb_pollfd **lupfd;
5af666a9
LPC
918 unsigned int i;
919 int ret;
610dbb70
JH
920 unsigned char *buf;
921
922 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
923 return SR_ERR;
924 ctx = sdi->priv;
c03f0450
LPC
925
926 if (ctx->submitted_transfers != 0)
927 return SR_ERR;
928
3cd3a20b 929 ctx->session_dev_id = cb_data;
2e526f4a 930 ctx->num_samples = 0;
2769eed9 931 ctx->empty_transfer_count = 0;
610dbb70 932
5af666a9
LPC
933 const unsigned int timeout = get_timeout(ctx);
934 const unsigned int num_transfers = get_number_of_transfers(ctx);
935 const size_t size = get_buffer_size(ctx);
936
0caa1ef0
LPC
937 ctx->transfers = g_try_malloc0(sizeof(*ctx->transfers) * num_transfers);
938 if (!ctx->transfers)
939 return SR_ERR;
940
941 ctx->num_transfers = num_transfers;
942
5af666a9 943 for (i = 0; i < num_transfers; i++) {
610dbb70 944 if (!(buf = g_try_malloc(size))) {
7ae2f9d5 945 sr_err("fx2lafw: %s: buf malloc failed.", __func__);
610dbb70
JH
946 return SR_ERR_MALLOC;
947 }
948 transfer = libusb_alloc_transfer(0);
949 libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
950 2 | LIBUSB_ENDPOINT_IN, buf, size,
5af666a9 951 receive_transfer, ctx, timeout);
610dbb70 952 if (libusb_submit_transfer(transfer) != 0) {
610dbb70
JH
953 libusb_free_transfer(transfer);
954 g_free(buf);
25f5d66a 955 abort_acquisition(ctx);
610dbb70
JH
956 return SR_ERR;
957 }
0caa1ef0 958 ctx->transfers[i] = transfer;
cb61e9f7 959 ctx->submitted_transfers++;
610dbb70
JH
960 }
961
962 lupfd = libusb_get_pollfds(usb_context);
963 for (i = 0; lupfd[i]; i++)
964 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
5af666a9 965 timeout, receive_data, NULL);
610dbb70
JH
966 free(lupfd); /* NOT g_free()! */
967
bd47acab
LPC
968 packet.type = SR_DF_HEADER;
969 packet.payload = &header;
970 header.feed_version = 1;
971 gettimeofday(&header.starttime, NULL);
972 sr_session_send(cb_data, &packet);
f366e86c
BV
973
974 /* Send metadata about the SR_DF_LOGIC packets to come. */
bd47acab
LPC
975 packet.type = SR_DF_META_LOGIC;
976 packet.payload = &meta;
f366e86c 977 meta.samplerate = ctx->cur_samplerate;
d1ddc7a9 978 meta.num_probes = ctx->sample_wide ? 16 : 8;
bd47acab 979 sr_session_send(cb_data, &packet);
610dbb70 980
ebc34738 981 if ((ret = command_start_acquisition (ctx->usb->devhdl,
d1ddc7a9 982 ctx->cur_samplerate, ctx->sample_wide)) != SR_OK) {
25f5d66a 983 abort_acquisition(ctx);
ebc34738 984 return ret;
017375d1
JH
985 }
986
f302a082
JH
987 return SR_OK;
988}
989
3cd3a20b 990/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
c8f2c9dd 991static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
f302a082 992{
2e526f4a 993 struct sr_dev_inst *sdi;
5da93902 994
f4a9e5c0 995 /* Avoid compiler warnings. */
2e526f4a 996 (void)cb_data;
5da93902 997
2e526f4a
JH
998 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
999 return SR_ERR;
1000
1001 abort_acquisition(sdi->priv);
5da93902 1002
f302a082
JH
1003 return SR_OK;
1004}
1005
c09f0b57 1006SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
f302a082 1007 .name = "fx2lafw",
2e7cb004 1008 .longname = "fx2lafw (generic driver for FX2 based LAs)",
f302a082
JH
1009 .api_version = 1,
1010 .init = hw_init,
1011 .cleanup = hw_cleanup,
1012 .dev_open = hw_dev_open,
1013 .dev_close = hw_dev_close,
1014 .dev_info_get = hw_dev_info_get,
1015 .dev_status_get = hw_dev_status_get,
1016 .hwcap_get_all = hw_hwcap_get_all,
1017 .dev_config_set = hw_dev_config_set,
1018 .dev_acquisition_start = hw_dev_acquisition_start,
1019 .dev_acquisition_stop = hw_dev_acquisition_stop,
1020};