]> sigrok.org Git - libsigrok.git/blob - src/hardware/fx2lafw/api.c
Add helper function for scan completion
[libsigrok.git] / src / hardware / fx2lafw / api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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 <config.h>
22 #include "protocol.h"
23 #include "dslogic.h"
24 #include <math.h>
25
26 static const struct fx2lafw_profile supported_fx2[] = {
27         /*
28          * CWAV USBee AX
29          * EE Electronics ESLA201A
30          * ARMFLY AX-Pro
31          */
32         { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
33                 "fx2lafw-cwav-usbeeax.fw",
34                 DEV_CAPS_AX_ANALOG, NULL, NULL},
35         /*
36          * CWAV USBee DX
37          * XZL-Studio DX
38          */
39         { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
40                 "fx2lafw-cwav-usbeedx.fw",
41                 DEV_CAPS_16BIT, NULL, NULL },
42
43         /*
44          * CWAV USBee SX
45          */
46         { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
47                 "fx2lafw-cwav-usbeesx.fw",
48                 0, NULL, NULL},
49
50         /* DreamSourceLab DSLogic (before FW upload) */
51         { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
52                 "dreamsourcelab-dslogic-fx2.fw",
53                 DEV_CAPS_16BIT, NULL, NULL},
54         /* DreamSourceLab DSLogic (after FW upload) */
55         { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
56                 "dreamsourcelab-dslogic-fx2.fw",
57                 DEV_CAPS_16BIT, "DreamSourceLab", "DSLogic"},
58
59         /* DreamSourceLab DSCope (before FW upload) */
60         { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
61                 "dreamsourcelab-dscope-fx2.fw",
62                 DEV_CAPS_16BIT, NULL, NULL},
63         /* DreamSourceLab DSCope (after FW upload) */
64         { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
65                 "dreamsourcelab-dscope-fx2.fw",
66                 DEV_CAPS_16BIT, "DreamSourceLab", "DSCope"},
67
68         /* DreamSourceLab DSLogic Pro (before FW upload) */
69         { 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
70                 "dreamsourcelab-dslogic-pro-fx2.fw",
71                 DEV_CAPS_16BIT, NULL, NULL},
72         /* DreamSourceLab DSLogic Pro (after FW upload) */
73         { 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
74                 "dreamsourcelab-dslogic-pro-fx2.fw",
75                 DEV_CAPS_16BIT, "DreamSourceLab", "DSLogic"},
76
77         /*
78          * Saleae Logic
79          * EE Electronics ESLA100
80          * Robomotic MiniLogic
81          * Robomotic BugLogic 3
82          */
83         { 0x0925, 0x3881, "Saleae", "Logic", NULL,
84                 "fx2lafw-saleae-logic.fw",
85                 0, NULL, NULL},
86
87         /*
88          * Default Cypress FX2 without EEPROM, e.g.:
89          * Lcsoft Mini Board
90          * Braintechnology USB Interface V2.x
91          */
92         { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
93                 "fx2lafw-cypress-fx2.fw",
94                 DEV_CAPS_16BIT, NULL, NULL },
95
96         /*
97          * Braintechnology USB-LPS
98          */
99         { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
100                 "fx2lafw-braintechnology-usb-lps.fw",
101                 DEV_CAPS_16BIT, NULL, NULL },
102
103         /*
104          * sigrok FX2 based 8-channel logic analyzer
105          */
106         { 0x1d50, 0x608c, "sigrok", "FX2 LA (8ch)", NULL,
107                 "fx2lafw-sigrok-fx2-8ch.fw",
108                 0, NULL, NULL},
109
110         /*
111          * sigrok FX2 based 16-channel logic analyzer
112          */
113         { 0x1d50, 0x608d, "sigrok", "FX2 LA (16ch)", NULL,
114                 "fx2lafw-sigrok-fx2-16ch.fw",
115                 DEV_CAPS_16BIT, NULL, NULL },
116
117         ALL_ZERO
118 };
119
120 static const uint32_t drvopts[] = {
121         SR_CONF_LOGIC_ANALYZER,
122 };
123
124 static const uint32_t scanopts[] = {
125         SR_CONF_CONN,
126 };
127
128 static const uint32_t devopts[] = {
129         SR_CONF_CONTINUOUS,
130         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
131         SR_CONF_CONN | SR_CONF_GET,
132         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
133         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
134         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
135 };
136
137 static const uint32_t dslogic_devopts[] = {
138         SR_CONF_CONTINUOUS | SR_CONF_SET | SR_CONF_GET,
139         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
140         SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
141         SR_CONF_CONN | SR_CONF_GET,
142         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
143         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
144         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
145         SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
146         SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
147 };
148
149 static const int32_t soft_trigger_matches[] = {
150         SR_TRIGGER_ZERO,
151         SR_TRIGGER_ONE,
152         SR_TRIGGER_RISING,
153         SR_TRIGGER_FALLING,
154         SR_TRIGGER_EDGE,
155 };
156
157 /* Names assigned to available edge slope choices. */
158 static const char *const signal_edge_names[] = {
159         [DS_EDGE_RISING] = "rising",
160         [DS_EDGE_FALLING] = "falling",
161 };
162
163 static const struct {
164         int range;
165         gdouble low;
166         gdouble high;
167 } volt_thresholds[] = {
168         { DS_VOLTAGE_RANGE_18_33_V, 0.7, 1.4 },
169         { DS_VOLTAGE_RANGE_5_V, 1.4, 3.6 },
170 };
171
172 static const uint64_t samplerates[] = {
173         SR_KHZ(20),
174         SR_KHZ(25),
175         SR_KHZ(50),
176         SR_KHZ(100),
177         SR_KHZ(200),
178         SR_KHZ(250),
179         SR_KHZ(500),
180         SR_MHZ(1),
181         SR_MHZ(2),
182         SR_MHZ(3),
183         SR_MHZ(4),
184         SR_MHZ(6),
185         SR_MHZ(8),
186         SR_MHZ(12),
187         SR_MHZ(16),
188         SR_MHZ(24),
189 };
190
191 static const uint64_t dslogic_samplerates[] = {
192         SR_KHZ(10),
193         SR_KHZ(20),
194         SR_KHZ(50),
195         SR_KHZ(100),
196         SR_KHZ(200),
197         SR_KHZ(500),
198         SR_MHZ(1),
199         SR_MHZ(2),
200         SR_MHZ(5),
201         SR_MHZ(10),
202         SR_MHZ(20),
203         SR_MHZ(25),
204         SR_MHZ(50),
205         SR_MHZ(100),
206         SR_MHZ(200),
207         SR_MHZ(400),
208 };
209
210 static GSList *scan(struct sr_dev_driver *di, GSList *options)
211 {
212         struct drv_context *drvc;
213         struct dev_context *devc;
214         struct sr_dev_inst *sdi;
215         struct sr_usb_dev_inst *usb;
216         struct sr_channel *ch;
217         struct sr_channel_group *cg;
218         struct sr_config *src;
219         const struct fx2lafw_profile *prof;
220         GSList *l, *devices, *conn_devices;
221         gboolean has_firmware;
222         struct libusb_device_descriptor des;
223         libusb_device **devlist;
224         struct libusb_device_handle *hdl;
225         int ret, i, j;
226         int num_logic_channels = 0, num_analog_channels = 0;
227         const char *conn;
228         char manufacturer[64], product[64], serial_num[64], connection_id[64];
229         char channel_name[16];
230
231         drvc = di->context;
232
233         conn = NULL;
234         for (l = options; l; l = l->next) {
235                 src = l->data;
236                 switch (src->key) {
237                 case SR_CONF_CONN:
238                         conn = g_variant_get_string(src->data, NULL);
239                         break;
240                 }
241         }
242         if (conn)
243                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
244         else
245                 conn_devices = NULL;
246
247         /* Find all fx2lafw compatible devices and upload firmware to them. */
248         devices = NULL;
249         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
250         for (i = 0; devlist[i]; i++) {
251                 if (conn) {
252                         usb = NULL;
253                         for (l = conn_devices; l; l = l->next) {
254                                 usb = l->data;
255                                 if (usb->bus == libusb_get_bus_number(devlist[i])
256                                         && usb->address == libusb_get_device_address(devlist[i]))
257                                         break;
258                         }
259                         if (!l)
260                                 /* This device matched none of the ones that
261                                  * matched the conn specification. */
262                                 continue;
263                 }
264
265                 libusb_get_device_descriptor( devlist[i], &des);
266
267                 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
268                         continue;
269
270                 if (des.iManufacturer == 0) {
271                         manufacturer[0] = '\0';
272                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
273                                 des.iManufacturer, (unsigned char *) manufacturer,
274                                 sizeof(manufacturer))) < 0) {
275                         sr_warn("Failed to get manufacturer string descriptor: %s.",
276                                 libusb_error_name(ret));
277                         continue;
278                 }
279
280                 if (des.iProduct == 0) {
281                         product[0] = '\0';
282                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
283                                 des.iProduct, (unsigned char *) product,
284                                 sizeof(product))) < 0) {
285                         sr_warn("Failed to get product string descriptor: %s.",
286                                 libusb_error_name(ret));
287                         continue;
288                 }
289
290                 if (des.iSerialNumber == 0) {
291                         serial_num[0] = '\0';
292                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
293                                 des.iSerialNumber, (unsigned char *) serial_num,
294                                 sizeof(serial_num))) < 0) {
295                         sr_warn("Failed to get serial number string descriptor: %s.",
296                                 libusb_error_name(ret));
297                         continue;
298                 }
299
300                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
301
302                 libusb_close(hdl);
303
304                 prof = NULL;
305                 for (j = 0; supported_fx2[j].vid; j++) {
306                         if (des.idVendor == supported_fx2[j].vid &&
307                                         des.idProduct == supported_fx2[j].pid &&
308                                         (!supported_fx2[j].usb_manufacturer ||
309                                          !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
310                                         (!supported_fx2[j].usb_manufacturer ||
311                                          !strcmp(product, supported_fx2[j].usb_product))) {
312                                 prof = &supported_fx2[j];
313                                 break;
314                         }
315                 }
316
317                 /* Skip if the device was not found. */
318                 if (!prof)
319                         continue;
320
321                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
322                 sdi->status = SR_ST_INITIALIZING;
323                 sdi->vendor = g_strdup(prof->vendor);
324                 sdi->model = g_strdup(prof->model);
325                 sdi->version = g_strdup(prof->model_version);
326                 sdi->serial_num = g_strdup(serial_num);
327                 sdi->connection_id = g_strdup(connection_id);
328
329                 /* Fill in channellist according to this device's profile. */
330                 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
331                 num_analog_channels = prof->dev_caps & DEV_CAPS_AX_ANALOG ? 1 : 0;
332
333                 /* Logic channels, all in one channel group. */
334                 cg = g_malloc0(sizeof(struct sr_channel_group));
335                 cg->name = g_strdup("Logic");
336                 for (j = 0; j < num_logic_channels; j++) {
337                         sprintf(channel_name, "D%d", j);
338                         ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
339                                                 TRUE, channel_name);
340                         cg->channels = g_slist_append(cg->channels, ch);
341                 }
342                 sdi->channel_groups = g_slist_append(NULL, cg);
343
344                 for (j = 0; j < num_analog_channels; j++) {
345                         snprintf(channel_name, 16, "A%d", j);
346                         ch = sr_channel_new(sdi, j + num_logic_channels,
347                                         SR_CHANNEL_ANALOG, TRUE, channel_name);
348
349                         /* Every analog channel gets its own channel group. */
350                         cg = g_malloc0(sizeof(struct sr_channel_group));
351                         cg->name = g_strdup(channel_name);
352                         cg->channels = g_slist_append(NULL, ch);
353                         sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
354                 }
355
356                 devc = fx2lafw_dev_new();
357                 devc->profile = prof;
358                 if ((prof->dev_caps & DEV_CAPS_16BIT) || (prof->dev_caps & DEV_CAPS_AX_ANALOG))
359                         devc->sample_wide = TRUE;
360                 sdi->priv = devc;
361                 devices = g_slist_append(devices, sdi);
362
363                 if (!strcmp(prof->model, "DSLogic")
364                                 || !strcmp(prof->model, "DSLogic Pro")
365                                 || !strcmp(prof->model, "DSCope")) {
366                         devc->dslogic = TRUE;
367                         devc->samplerates = dslogic_samplerates;
368                         devc->num_samplerates = ARRAY_SIZE(dslogic_samplerates);
369                         has_firmware = match_manuf_prod(devlist[i], "DreamSourceLab", "DSLogic")
370                                         || match_manuf_prod(devlist[i], "DreamSourceLab", "DSCope");
371                 } else {
372                         devc->dslogic = FALSE;
373                         devc->samplerates = samplerates;
374                         devc->num_samplerates = ARRAY_SIZE(samplerates);
375                         has_firmware = match_manuf_prod(devlist[i],
376                                         "sigrok", "fx2lafw");
377                 }
378
379                 if (has_firmware) {
380                         /* Already has the firmware, so fix the new address. */
381                         sr_dbg("Found an fx2lafw device.");
382                         sdi->status = SR_ST_INACTIVE;
383                         sdi->inst_type = SR_INST_USB;
384                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
385                                         libusb_get_device_address(devlist[i]), NULL);
386                 } else {
387                         if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
388                                         USB_CONFIGURATION, prof->firmware) == SR_OK)
389                                 /* Store when this device's FW was updated. */
390                                 devc->fw_updated = g_get_monotonic_time();
391                         else
392                                 sr_err("Firmware upload failed for "
393                                        "device %d.%d (logical).",
394                                        libusb_get_bus_number(devlist[i]),
395                                        libusb_get_device_address(devlist[i]));
396                         sdi->inst_type = SR_INST_USB;
397                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
398                                         0xff, NULL);
399                 }
400         }
401         libusb_free_device_list(devlist, 1);
402         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
403
404         return std_scan_complete(di, devices);
405 }
406
407 static void clear_dev_context(void *priv)
408 {
409         struct dev_context *devc;
410
411         devc = priv;
412         g_slist_free(devc->enabled_analog_channels);
413         g_free(devc);
414 }
415
416 static int dev_clear(const struct sr_dev_driver *di)
417 {
418         return std_dev_clear(di, clear_dev_context);
419 }
420
421 static int dev_open(struct sr_dev_inst *sdi)
422 {
423         struct sr_dev_driver *di = sdi->driver;
424         struct sr_usb_dev_inst *usb;
425         struct dev_context *devc;
426         const char *fpga_firmware = NULL;
427         int ret;
428         int64_t timediff_us, timediff_ms;
429
430         devc = sdi->priv;
431         usb = sdi->conn;
432
433         /*
434          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
435          * milliseconds for the FX2 to renumerate.
436          */
437         ret = SR_ERR;
438         if (devc->fw_updated > 0) {
439                 sr_info("Waiting for device to reset.");
440                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
441                 g_usleep(300 * 1000);
442                 timediff_ms = 0;
443                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
444                         if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
445                                 break;
446                         g_usleep(100 * 1000);
447
448                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
449                         timediff_ms = timediff_us / 1000;
450                         sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
451                 }
452                 if (ret != SR_OK) {
453                         sr_err("Device failed to renumerate.");
454                         return SR_ERR;
455                 }
456                 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
457         } else {
458                 sr_info("Firmware upload was not needed.");
459                 ret = fx2lafw_dev_open(sdi, di);
460         }
461
462         if (ret != SR_OK) {
463                 sr_err("Unable to open device.");
464                 return SR_ERR;
465         }
466
467         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
468         if (ret != 0) {
469                 switch (ret) {
470                 case LIBUSB_ERROR_BUSY:
471                         sr_err("Unable to claim USB interface. Another "
472                                "program or driver has already claimed it.");
473                         break;
474                 case LIBUSB_ERROR_NO_DEVICE:
475                         sr_err("Device has been disconnected.");
476                         break;
477                 default:
478                         sr_err("Unable to claim interface: %s.",
479                                libusb_error_name(ret));
480                         break;
481                 }
482
483                 return SR_ERR;
484         }
485
486         if (devc->dslogic) {
487                 if (!strcmp(devc->profile->model, "DSLogic")) {
488                         if (devc->dslogic_voltage_threshold == DS_VOLTAGE_RANGE_18_33_V)
489                                 fpga_firmware = DSLOGIC_FPGA_FIRMWARE_3V3;
490                         else
491                                 fpga_firmware = DSLOGIC_FPGA_FIRMWARE_5V;
492                 } else if (!strcmp(devc->profile->model, "DSLogic Pro")){
493                         fpga_firmware = DSLOGIC_PRO_FPGA_FIRMWARE;
494                 } else if (!strcmp(devc->profile->model, "DSCope")) {
495                         fpga_firmware = DSCOPE_FPGA_FIRMWARE;
496                 }
497
498                 if ((ret = dslogic_fpga_firmware_upload(sdi, fpga_firmware)) != SR_OK)
499                         return ret;
500         }
501         if (devc->cur_samplerate == 0) {
502                 /* Samplerate hasn't been set; default to the slowest one. */
503                 devc->cur_samplerate = devc->samplerates[0];
504         }
505
506         return SR_OK;
507 }
508
509 static int dev_close(struct sr_dev_inst *sdi)
510 {
511         struct sr_usb_dev_inst *usb;
512
513         usb = sdi->conn;
514
515         if (!usb->devhdl)
516                 return SR_ERR;
517
518         sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
519                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
520         libusb_release_interface(usb->devhdl, USB_INTERFACE);
521         libusb_close(usb->devhdl);
522         usb->devhdl = NULL;
523         sdi->status = SR_ST_INACTIVE;
524
525         return SR_OK;
526 }
527
528 static int config_get(uint32_t key, GVariant **data,
529         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
530 {
531         struct dev_context *devc;
532         struct sr_usb_dev_inst *usb;
533         GVariant *range[2];
534         unsigned int i;
535         char str[128];
536
537         (void)cg;
538
539         if (!sdi)
540                 return SR_ERR_ARG;
541
542         devc = sdi->priv;
543
544         switch (key) {
545         case SR_CONF_CONN:
546                 if (!sdi->conn)
547                         return SR_ERR_ARG;
548                 usb = sdi->conn;
549                 if (usb->address == 255)
550                         /* Device still needs to re-enumerate after firmware
551                          * upload, so we don't know its (future) address. */
552                         return SR_ERR;
553                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
554                 *data = g_variant_new_string(str);
555                 break;
556         case SR_CONF_VOLTAGE_THRESHOLD:
557                 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
558                         if (volt_thresholds[i].range != devc->dslogic_voltage_threshold)
559                                 continue;
560                         range[0] = g_variant_new_double(volt_thresholds[i].low);
561                         range[1] = g_variant_new_double(volt_thresholds[i].high);
562                         *data = g_variant_new_tuple(range, 2);
563                         break;
564                 }
565                 break;
566         case SR_CONF_LIMIT_SAMPLES:
567                 *data = g_variant_new_uint64(devc->limit_samples);
568                 break;
569         case SR_CONF_SAMPLERATE:
570                 *data = g_variant_new_uint64(devc->cur_samplerate);
571                 break;
572         case SR_CONF_CAPTURE_RATIO:
573                 *data = g_variant_new_uint64(devc->capture_ratio);
574                 break;
575         case SR_CONF_EXTERNAL_CLOCK:
576                 *data = g_variant_new_boolean(devc->dslogic_external_clock);
577                 break;
578         case SR_CONF_CONTINUOUS:
579                 *data = g_variant_new_boolean(devc->dslogic_continuous_mode);
580                 break;
581         case SR_CONF_CLOCK_EDGE:
582                 i = devc->dslogic_clock_edge;
583                 if (i >= ARRAY_SIZE(signal_edge_names))
584                         return SR_ERR_BUG;
585                 *data = g_variant_new_string(signal_edge_names[0]);
586                 break;
587         default:
588                 return SR_ERR_NA;
589         }
590
591         return SR_OK;
592 }
593
594 /*
595  * Helper for mapping a string-typed configuration value to an index
596  * within a table of possible values.
597  */
598 static int lookup_index(GVariant *value, const char *const *table, int len)
599 {
600         const char *entry;
601         int i;
602
603         entry = g_variant_get_string(value, NULL);
604         if (!entry)
605                 return -1;
606
607         /* Linear search is fine for very small tables. */
608         for (i = 0; i < len; i++) {
609                 if (strcmp(entry, table[i]) == 0)
610                         return i;
611         }
612
613         return -1;
614 }
615
616 static int config_set(uint32_t key, GVariant *data,
617         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
618 {
619         struct dev_context *devc;
620         uint64_t arg;
621         int i, ret;
622         gdouble low, high;
623
624         (void)cg;
625
626         if (!sdi)
627                 return SR_ERR_ARG;
628
629         if (sdi->status != SR_ST_ACTIVE)
630                 return SR_ERR;
631
632         devc = sdi->priv;
633
634         ret = SR_OK;
635
636         switch (key) {
637         case SR_CONF_SAMPLERATE:
638                 arg = g_variant_get_uint64(data);
639                 for (i = 0; i < devc->num_samplerates; i++) {
640                         if (devc->samplerates[i] == arg) {
641                                 devc->cur_samplerate = arg;
642                                 break;
643                         }
644                 }
645                 if (i == devc->num_samplerates)
646                         ret = SR_ERR_ARG;
647                 break;
648         case SR_CONF_LIMIT_SAMPLES:
649                 devc->limit_samples = g_variant_get_uint64(data);
650                 break;
651         case SR_CONF_CAPTURE_RATIO:
652                 devc->capture_ratio = g_variant_get_uint64(data);
653                 ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
654                 break;
655         case SR_CONF_VOLTAGE_THRESHOLD:
656                 g_variant_get(data, "(dd)", &low, &high);
657                 ret = SR_ERR_ARG;
658                 for (i = 0; (unsigned int)i < ARRAY_SIZE(volt_thresholds); i++) {
659                         if (fabs(volt_thresholds[i].low - low) < 0.1 &&
660                             fabs(volt_thresholds[i].high - high) < 0.1) {
661                                 devc->dslogic_voltage_threshold = volt_thresholds[i].range;
662                                 break;
663                         }
664                 }
665                 if (!strcmp(devc->profile->model, "DSLogic")) {
666                         if (devc->dslogic_voltage_threshold == DS_VOLTAGE_RANGE_5_V)
667                                 ret = dslogic_fpga_firmware_upload(sdi, DSLOGIC_FPGA_FIRMWARE_5V);
668                         else
669                                 ret = dslogic_fpga_firmware_upload(sdi, DSLOGIC_FPGA_FIRMWARE_3V3);
670                 } else if (!strcmp(devc->profile->model, "DSLogic Pro")) {
671                         ret = dslogic_fpga_firmware_upload(sdi, DSLOGIC_PRO_FPGA_FIRMWARE);
672                 }
673                 break;
674         case SR_CONF_EXTERNAL_CLOCK:
675                 devc->dslogic_external_clock = g_variant_get_boolean(data);
676                 break;
677         case SR_CONF_CONTINUOUS:
678                 devc->dslogic_continuous_mode = g_variant_get_boolean(data);
679                 break;
680         case SR_CONF_CLOCK_EDGE:
681                 i = lookup_index(data, signal_edge_names,
682                                    ARRAY_SIZE(signal_edge_names));
683                 if (i < 0)
684                         return SR_ERR_ARG;
685                 devc->dslogic_clock_edge = i;
686                 break;          
687         default:
688                 ret = SR_ERR_NA;
689         }
690
691         return ret;
692 }
693
694 static int config_list(uint32_t key, GVariant **data,
695         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
696 {
697         struct dev_context *devc;
698         GVariant *gvar, *range[2];
699         GVariantBuilder gvb;
700         unsigned int i;
701
702         (void)cg;
703
704         switch (key) {
705         case SR_CONF_SCAN_OPTIONS:
706                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
707                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
708                 break;
709         case SR_CONF_DEVICE_OPTIONS:
710                 if (!sdi) {
711                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
712                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
713                 } else {
714                         devc = sdi->priv;
715                         if (!devc->dslogic)
716                                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
717                                                                   devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
718                         else
719                                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
720                                                                   dslogic_devopts, ARRAY_SIZE(dslogic_devopts), sizeof(uint32_t));
721                 }
722                 break;
723         case SR_CONF_VOLTAGE_THRESHOLD:
724                 if (!sdi->priv)
725                         return SR_ERR_ARG;
726                 devc = sdi->priv;
727                 if (!devc->dslogic)
728                         return SR_ERR_NA;
729                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
730                 for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
731                         range[0] = g_variant_new_double(volt_thresholds[i].low);
732                         range[1] = g_variant_new_double(volt_thresholds[i].high);
733                         gvar = g_variant_new_tuple(range, 2);
734                         g_variant_builder_add_value(&gvb, gvar);
735                 }
736                 *data = g_variant_builder_end(&gvb);
737                 break;
738         case SR_CONF_SAMPLERATE:
739                 devc = sdi->priv;
740                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
741                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), devc->samplerates,
742                                 devc->num_samplerates, sizeof(uint64_t));
743                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
744                 *data = g_variant_builder_end(&gvb);
745                 break;
746         case SR_CONF_TRIGGER_MATCH:
747                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
748                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
749                                 sizeof(int32_t));
750                 break;
751         case SR_CONF_CLOCK_EDGE:
752                 *data = g_variant_new_strv(signal_edge_names,
753                         ARRAY_SIZE(signal_edge_names));
754                 break;
755         default:
756                 return SR_ERR_NA;
757         }
758
759         return SR_OK;
760 }
761
762 static int receive_data(int fd, int revents, void *cb_data)
763 {
764         struct timeval tv;
765         struct drv_context *drvc;
766
767         (void)fd;
768         (void)revents;
769
770         drvc = (struct drv_context *)cb_data;
771
772         tv.tv_sec = tv.tv_usec = 0;
773         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
774
775         return TRUE;
776 }
777
778 static int start_transfers(const struct sr_dev_inst *sdi)
779 {
780         struct dev_context *devc;
781         struct sr_usb_dev_inst *usb;
782         struct sr_trigger *trigger;
783         struct libusb_transfer *transfer;
784         unsigned int i, num_transfers;
785         int endpoint, timeout, ret;
786         unsigned char *buf;
787         size_t size;
788
789         devc = sdi->priv;
790         usb = sdi->conn;
791
792         devc->sent_samples = 0;
793         devc->acq_aborted = FALSE;
794         devc->empty_transfer_count = 0;
795
796         if ((trigger = sr_session_trigger_get(sdi->session)) && !devc->dslogic) {
797                 int pre_trigger_samples = 0;
798                 if (devc->limit_samples > 0)
799                         pre_trigger_samples = devc->capture_ratio * devc->limit_samples/100;
800                 devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
801                 if (!devc->stl)
802                         return SR_ERR_MALLOC;
803                 devc->trigger_fired = FALSE;
804         } else
805                 devc->trigger_fired = TRUE;
806
807         num_transfers = fx2lafw_get_number_of_transfers(devc);
808
809         //if (devc->dslogic)
810         //      num_transfers = dslogic_get_number_of_transfers(devc);
811
812         if (devc->dslogic) {
813                 if (devc->cur_samplerate == SR_MHZ(100))
814                         num_transfers = 16;
815                 else if (devc->cur_samplerate == SR_MHZ(200))
816                         num_transfers = 8;
817                 else if (devc->cur_samplerate == SR_MHZ(400))
818                         num_transfers = 4;
819         }
820
821         size = fx2lafw_get_buffer_size(devc);
822         devc->submitted_transfers = 0;
823
824         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
825         if (!devc->transfers) {
826                 sr_err("USB transfers malloc failed.");
827                 return SR_ERR_MALLOC;
828         }
829
830         timeout = fx2lafw_get_timeout(devc);
831         endpoint = devc->dslogic ? 6 : 2;
832         devc->num_transfers = num_transfers;
833         for (i = 0; i < num_transfers; i++) {
834                 if (!(buf = g_try_malloc(size))) {
835                         sr_err("USB transfer buffer malloc failed.");
836                         return SR_ERR_MALLOC;
837                 }
838                 transfer = libusb_alloc_transfer(0);
839                 libusb_fill_bulk_transfer(transfer, usb->devhdl,
840                                 endpoint | LIBUSB_ENDPOINT_IN, buf, size,
841                                 fx2lafw_receive_transfer, (void *)sdi, timeout);
842                 sr_info("submitting transfer: %d", i);
843                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
844                         sr_err("Failed to submit transfer: %s.",
845                                libusb_error_name(ret));
846                         libusb_free_transfer(transfer);
847                         g_free(buf);
848                         fx2lafw_abort_acquisition(devc);
849                         return SR_ERR;
850                 }
851                 devc->transfers[i] = transfer;
852                 devc->submitted_transfers++;
853         }
854
855         if (devc->profile->dev_caps & DEV_CAPS_AX_ANALOG)
856                 devc->send_data_proc = mso_send_data_proc;
857         else
858                 devc->send_data_proc = la_send_data_proc;
859
860         std_session_send_df_header(sdi, LOG_PREFIX);
861
862         return SR_OK;
863 }
864
865 static void LIBUSB_CALL dslogic_trigger_receive(struct libusb_transfer *transfer)
866 {
867         const struct sr_dev_inst *sdi;
868         struct dslogic_trigger_pos *tpos;
869         struct dev_context *devc;
870
871         sdi = transfer->user_data;
872         devc = sdi->priv;
873         if (transfer->status == LIBUSB_TRANSFER_CANCELLED) {
874                 sr_dbg("Trigger transfer canceled.");
875                 /* Terminate session. */
876                 std_session_send_df_end(sdi, LOG_PREFIX);
877                 usb_source_remove(sdi->session, devc->ctx);
878                 devc->num_transfers = 0;
879                 g_free(devc->transfers);
880                 if (devc->stl) {
881                         soft_trigger_logic_free(devc->stl);
882                         devc->stl = NULL;
883                 }
884         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED
885                         && transfer->actual_length == sizeof(struct dslogic_trigger_pos)) {
886                 tpos = (struct dslogic_trigger_pos *)transfer->buffer;
887                 sr_info("tpos real_pos %d ram_saddr %d cnt %d", tpos->real_pos,
888                         tpos->ram_saddr, tpos->remain_cnt);
889                 devc->trigger_pos = tpos->real_pos;
890                 g_free(tpos);
891                 start_transfers(sdi);
892         }
893         libusb_free_transfer(transfer);
894 }
895
896 static int dslogic_trigger_request(const struct sr_dev_inst *sdi)
897 {
898         struct sr_usb_dev_inst *usb;
899         struct libusb_transfer *transfer;
900         struct dslogic_trigger_pos *tpos;
901         struct dev_context *devc;
902         int ret;
903
904         usb = sdi->conn;
905         devc = sdi->priv;
906
907         if ((ret = dslogic_stop_acquisition(sdi)) != SR_OK)
908                 return ret;
909
910         if ((ret = dslogic_fpga_configure(sdi)) != SR_OK)
911                 return ret;
912
913         /* If this is a DSLogic Pro, set the voltage threshold. */
914         if (!strcmp(devc->profile->model, "DSLogic Pro")){
915                 if (devc->dslogic_voltage_threshold == DS_VOLTAGE_RANGE_18_33_V) {
916                         dslogic_set_vth(sdi, 1.4);
917                 } else {
918                         dslogic_set_vth(sdi, 3.3);
919                 }
920         }
921
922         if ((ret = dslogic_start_acquisition(sdi)) != SR_OK)
923                 return ret;
924
925         sr_dbg("Getting trigger.");
926         tpos = g_malloc(sizeof(struct dslogic_trigger_pos));
927         transfer = libusb_alloc_transfer(0);
928         libusb_fill_bulk_transfer(transfer, usb->devhdl, 6 | LIBUSB_ENDPOINT_IN,
929                         (unsigned char *)tpos, sizeof(struct dslogic_trigger_pos),
930                         dslogic_trigger_receive, (void *)sdi, 0);
931         if ((ret = libusb_submit_transfer(transfer)) < 0) {
932                 sr_err("Failed to request trigger: %s.", libusb_error_name(ret));
933                 libusb_free_transfer(transfer);
934                 g_free(tpos);
935                 return SR_ERR;
936         }
937
938         devc->transfers = g_try_malloc0(sizeof(*devc->transfers));
939         if (!devc->transfers) {
940                 sr_err("USB trigger_pos transfer malloc failed.");
941                 return SR_ERR_MALLOC;
942         }
943         devc->num_transfers = 1;
944         devc->submitted_transfers++;
945         devc->transfers[0] = transfer;
946
947         return ret;
948 }
949
950 static int configure_channels(const struct sr_dev_inst *sdi)
951 {
952         struct dev_context *devc;
953         const GSList *l;
954         int p;
955         struct sr_channel *ch;
956
957         devc = sdi->priv;
958
959         g_slist_free(devc->enabled_analog_channels);
960         devc->enabled_analog_channels = NULL;
961         memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
962
963         for (l = sdi->channels, p = 0; l; l = l->next, p++) {
964                 ch = l->data;
965                 if ((p <= NUM_CHANNELS) && (ch->type == SR_CHANNEL_ANALOG)) {
966                         devc->ch_enabled[p] = ch->enabled;
967                         devc->enabled_analog_channels =
968                             g_slist_append(devc->enabled_analog_channels, ch);
969                 }
970         }
971
972         return SR_OK;
973 }
974
975 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
976 {
977         struct sr_dev_driver *di;
978         struct drv_context *drvc;
979         struct dev_context *devc;
980         int timeout, ret;
981         size_t size;
982
983         if (sdi->status != SR_ST_ACTIVE)
984                 return SR_ERR_DEV_CLOSED;
985
986         di = sdi->driver;
987         drvc = di->context;
988         devc = sdi->priv;
989
990         devc->ctx = drvc->sr_ctx;
991         devc->sent_samples = 0;
992         devc->empty_transfer_count = 0;
993         devc->acq_aborted = FALSE;
994
995         if (configure_channels(sdi) != SR_OK) {
996                 sr_err("Failed to configure channels.");
997                 return SR_ERR;
998         }
999
1000         timeout = fx2lafw_get_timeout(devc);
1001         usb_source_add(sdi->session, devc->ctx, timeout, receive_data, drvc);
1002
1003         if (devc->dslogic) {
1004                 dslogic_trigger_request(sdi);
1005         } else {
1006                 size = fx2lafw_get_buffer_size(devc);
1007                 /* Prepare for analog sampling. */
1008                 if (devc->profile->dev_caps & DEV_CAPS_AX_ANALOG) {
1009                         /* We need a buffer half the size of a transfer. */
1010                         devc->logic_buffer = g_try_malloc(size / 2);
1011                         devc->analog_buffer = g_try_malloc(
1012                                 sizeof(float) * size / 2);
1013                 }
1014                 start_transfers(sdi);
1015                 if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
1016                         fx2lafw_abort_acquisition(devc);
1017                         return ret;
1018                 }
1019         }
1020
1021         return SR_OK;
1022 }
1023
1024 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
1025 {
1026         struct dev_context *devc;
1027
1028         devc = sdi->priv;
1029
1030         if (devc->dslogic)
1031                 dslogic_stop_acquisition(sdi);
1032
1033         fx2lafw_abort_acquisition(sdi->priv);
1034
1035         return SR_OK;
1036 }
1037
1038 static struct sr_dev_driver fx2lafw_driver_info = {
1039         .name = "fx2lafw",
1040         .longname = "fx2lafw (generic driver for FX2 based LAs)",
1041         .api_version = 1,
1042         .init = std_init,
1043         .cleanup = std_cleanup,
1044         .scan = scan,
1045         .dev_list = std_dev_list,
1046         .dev_clear = dev_clear,
1047         .config_get = config_get,
1048         .config_set = config_set,
1049         .config_list = config_list,
1050         .dev_open = dev_open,
1051         .dev_close = dev_close,
1052         .dev_acquisition_start = dev_acquisition_start,
1053         .dev_acquisition_stop = dev_acquisition_stop,
1054         .context = NULL,
1055 };
1056 SR_REGISTER_DEV_DRIVER(fx2lafw_driver_info);