]> sigrok.org Git - libsigrok.git/blob - src/hardware/fx2lafw/api.c
soft-trigger: Add support for pre-triggering.
[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 "protocol.h"
22
23 static const struct fx2lafw_profile supported_fx2[] = {
24         /*
25          * CWAV USBee AX
26          * EE Electronics ESLA201A
27          * ARMFLY AX-Pro
28          */
29         { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
30                 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
31                 0, NULL, NULL},
32         /*
33          * CWAV USBee DX
34          * XZL-Studio DX
35          */
36         { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
37                 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
38                 DEV_CAPS_16BIT, NULL, NULL },
39
40         /*
41          * CWAV USBee SX
42          */
43         { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
44                 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
45                 0, NULL, NULL},
46
47         /*
48          * Saleae Logic
49          * EE Electronics ESLA100
50          * Robomotic MiniLogic
51          * Robomotic BugLogic 3
52          */
53         { 0x0925, 0x3881, "Saleae", "Logic", NULL,
54                 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
55                 0, NULL, NULL},
56
57         /*
58          * Default Cypress FX2 without EEPROM, e.g.:
59          * Lcsoft Mini Board
60          * Braintechnology USB Interface V2.x
61          */
62         { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
63                 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
64                 DEV_CAPS_16BIT, NULL, NULL },
65
66         /*
67          * Braintechnology USB-LPS
68          */
69         { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
70                 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
71                 DEV_CAPS_16BIT, NULL, NULL },
72
73         { 0, 0, 0, 0, 0, 0, 0, 0, 0 }
74 };
75
76 static const uint32_t drvopts[] = {
77         SR_CONF_LOGIC_ANALYZER,
78 };
79
80 static const uint32_t scanopts[] = {
81         SR_CONF_CONN,
82 };
83
84 static const uint32_t devopts[] = {
85         SR_CONF_CONTINUOUS | SR_CONF_SET,
86         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
87         SR_CONF_CONN | SR_CONF_GET,
88         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
89         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
90 };
91
92 static const char *channel_names[] = {
93         "0",  "1",  "2",  "3",  "4",  "5",  "6",  "7",
94         "8",  "9", "10", "11", "12", "13", "14", "15",
95         NULL,
96 };
97
98 static const int32_t soft_trigger_matches[] = {
99         SR_TRIGGER_ZERO,
100         SR_TRIGGER_ONE,
101         SR_TRIGGER_RISING,
102         SR_TRIGGER_FALLING,
103         SR_TRIGGER_EDGE,
104 };
105
106 static const uint64_t samplerates[] = {
107         SR_KHZ(20),
108         SR_KHZ(25),
109         SR_KHZ(50),
110         SR_KHZ(100),
111         SR_KHZ(200),
112         SR_KHZ(250),
113         SR_KHZ(500),
114         SR_MHZ(1),
115         SR_MHZ(2),
116         SR_MHZ(3),
117         SR_MHZ(4),
118         SR_MHZ(6),
119         SR_MHZ(8),
120         SR_MHZ(12),
121         SR_MHZ(16),
122         SR_MHZ(24),
123 };
124
125 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
126 static struct sr_dev_driver *di = &fx2lafw_driver_info;
127
128 static int init(struct sr_context *sr_ctx)
129 {
130         return std_init(sr_ctx, di, LOG_PREFIX);
131 }
132
133 static GSList *scan(GSList *options)
134 {
135         struct drv_context *drvc;
136         struct dev_context *devc;
137         struct sr_dev_inst *sdi;
138         struct sr_usb_dev_inst *usb;
139         struct sr_channel *ch;
140         struct sr_config *src;
141         const struct fx2lafw_profile *prof;
142         GSList *l, *devices, *conn_devices;
143         struct libusb_device_descriptor des;
144         libusb_device **devlist;
145         struct libusb_device_handle *hdl;
146         int num_logic_channels, ret, i, j;
147         const char *conn;
148         char manufacturer[64], product[64], serial_num[64], connection_id[64];
149
150         drvc = di->priv;
151
152         conn = NULL;
153         for (l = options; l; l = l->next) {
154                 src = l->data;
155                 switch (src->key) {
156                 case SR_CONF_CONN:
157                         conn = g_variant_get_string(src->data, NULL);
158                         break;
159                 }
160         }
161         if (conn)
162                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
163         else
164                 conn_devices = NULL;
165
166         /* Find all fx2lafw compatible devices and upload firmware to them. */
167         devices = NULL;
168         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
169         for (i = 0; devlist[i]; i++) {
170                 if (conn) {
171                         usb = NULL;
172                         for (l = conn_devices; l; l = l->next) {
173                                 usb = l->data;
174                                 if (usb->bus == libusb_get_bus_number(devlist[i])
175                                         && usb->address == libusb_get_device_address(devlist[i]))
176                                         break;
177                         }
178                         if (!l)
179                                 /* This device matched none of the ones that
180                                  * matched the conn specification. */
181                                 continue;
182                 }
183
184                 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
185                         sr_warn("Failed to get device descriptor: %s.",
186                                 libusb_error_name(ret));
187                         continue;
188                 }
189
190                 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
191                         continue;
192
193                 if (des.iManufacturer == 0) {
194                         manufacturer[0] = '\0';
195                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
196                                 des.iManufacturer, (unsigned char *) manufacturer,
197                                 sizeof(manufacturer))) < 0) {
198                         sr_warn("Failed to get manufacturer string descriptor: %s.",
199                                 libusb_error_name(ret));
200                         continue;
201                 }
202
203                 if (des.iProduct == 0) {
204                         product[0] = '\0';
205                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
206                                 des.iProduct, (unsigned char *) product,
207                                 sizeof(product))) < 0) {
208                         sr_warn("Failed to get product string descriptor: %s.",
209                                 libusb_error_name(ret));
210                         continue;
211                 }
212
213                 if (des.iSerialNumber == 0) {
214                         serial_num[0] = '\0';
215                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
216                                 des.iSerialNumber, (unsigned char *) serial_num,
217                                 sizeof(serial_num))) < 0) {
218                         sr_warn("Failed to get serial number string descriptor: %s.",
219                                 libusb_error_name(ret));
220                         continue;
221                 }
222
223                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
224
225                 libusb_close(hdl);
226
227                 prof = NULL;
228                 for (j = 0; supported_fx2[j].vid; j++) {
229                         if (des.idVendor == supported_fx2[j].vid &&
230                                         des.idProduct == supported_fx2[j].pid &&
231                                         (!supported_fx2[j].usb_manufacturer ||
232                                          !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
233                                         (!supported_fx2[j].usb_manufacturer ||
234                                          !strcmp(product, supported_fx2[j].usb_product))) {
235                                 prof = &supported_fx2[j];
236                                 break;
237                         }
238                 }
239
240                 /* Skip if the device was not found. */
241                 if (!prof)
242                         continue;
243
244                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
245                 sdi->status = SR_ST_INITIALIZING;
246                 sdi->vendor = g_strdup(prof->vendor);
247                 sdi->model = g_strdup(prof->model);
248                 sdi->version = g_strdup(prof->model_version);
249                 sdi->driver = di;
250                 sdi->serial_num = g_strdup(serial_num);
251                 sdi->connection_id = g_strdup(connection_id);
252
253                 /* Fill in channellist according to this device's profile. */
254                 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
255                 for (j = 0; j < num_logic_channels; j++) {
256                         ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
257                                         channel_names[j]);
258                         sdi->channels = g_slist_append(sdi->channels, ch);
259                 }
260
261                 devc = fx2lafw_dev_new();
262                 devc->profile = prof;
263                 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
264                 sdi->priv = devc;
265                 drvc->instances = g_slist_append(drvc->instances, sdi);
266                 devices = g_slist_append(devices, sdi);
267
268                 if (fx2lafw_check_conf_profile(devlist[i])) {
269                         /* Already has the firmware, so fix the new address. */
270                         sr_dbg("Found an fx2lafw device.");
271                         sdi->status = SR_ST_INACTIVE;
272                         sdi->inst_type = SR_INST_USB;
273                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
274                                         libusb_get_device_address(devlist[i]), NULL);
275                 } else {
276                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
277                                 prof->firmware) == SR_OK)
278                                 /* Store when this device's FW was updated. */
279                                 devc->fw_updated = g_get_monotonic_time();
280                         else
281                                 sr_err("Firmware upload failed for "
282                                        "device %d.%d (logical).",
283                                        libusb_get_bus_number(devlist[i]),
284                                        libusb_get_device_address(devlist[i]));
285                         sdi->inst_type = SR_INST_USB;
286                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
287                                         0xff, NULL);
288                 }
289         }
290         libusb_free_device_list(devlist, 1);
291         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
292
293         return devices;
294 }
295
296 static GSList *dev_list(void)
297 {
298         return ((struct drv_context *)(di->priv))->instances;
299 }
300
301 static int dev_open(struct sr_dev_inst *sdi)
302 {
303         struct sr_usb_dev_inst *usb;
304         struct dev_context *devc;
305         int ret;
306         int64_t timediff_us, timediff_ms;
307
308         devc = sdi->priv;
309         usb = sdi->conn;
310
311         /*
312          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
313          * milliseconds for the FX2 to renumerate.
314          */
315         ret = SR_ERR;
316         if (devc->fw_updated > 0) {
317                 sr_info("Waiting for device to reset.");
318                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
319                 g_usleep(300 * 1000);
320                 timediff_ms = 0;
321                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
322                         if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
323                                 break;
324                         g_usleep(100 * 1000);
325
326                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
327                         timediff_ms = timediff_us / 1000;
328                         sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
329                 }
330                 if (ret != SR_OK) {
331                         sr_err("Device failed to renumerate.");
332                         return SR_ERR;
333                 }
334                 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
335         } else {
336                 sr_info("Firmware upload was not needed.");
337                 ret = fx2lafw_dev_open(sdi, di);
338         }
339
340         if (ret != SR_OK) {
341                 sr_err("Unable to open device.");
342                 return SR_ERR;
343         }
344
345         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
346         if (ret != 0) {
347                 switch (ret) {
348                 case LIBUSB_ERROR_BUSY:
349                         sr_err("Unable to claim USB interface. Another "
350                                "program or driver has already claimed it.");
351                         break;
352                 case LIBUSB_ERROR_NO_DEVICE:
353                         sr_err("Device has been disconnected.");
354                         break;
355                 default:
356                         sr_err("Unable to claim interface: %s.",
357                                libusb_error_name(ret));
358                         break;
359                 }
360
361                 return SR_ERR;
362         }
363
364         if (devc->cur_samplerate == 0) {
365                 /* Samplerate hasn't been set; default to the slowest one. */
366                 devc->cur_samplerate = samplerates[0];
367         }
368
369         return SR_OK;
370 }
371
372 static int dev_close(struct sr_dev_inst *sdi)
373 {
374         struct sr_usb_dev_inst *usb;
375
376         usb = sdi->conn;
377         if (usb->devhdl == NULL)
378                 return SR_ERR;
379
380         sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
381                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
382         libusb_release_interface(usb->devhdl, USB_INTERFACE);
383         libusb_close(usb->devhdl);
384         usb->devhdl = NULL;
385         sdi->status = SR_ST_INACTIVE;
386
387         return SR_OK;
388 }
389
390 static int cleanup(void)
391 {
392         int ret;
393         struct drv_context *drvc;
394
395         if (!(drvc = di->priv))
396                 return SR_OK;
397
398         ret = std_dev_clear(di, NULL);
399
400         g_free(drvc);
401         di->priv = NULL;
402
403         return ret;
404 }
405
406 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
407                 const struct sr_channel_group *cg)
408 {
409         struct dev_context *devc;
410         struct sr_usb_dev_inst *usb;
411         char str[128];
412
413         (void)cg;
414
415         if (!sdi)
416                 return SR_ERR_ARG;
417
418         devc = sdi->priv;
419
420         switch (key) {
421         case SR_CONF_CONN:
422                 if (!sdi->conn)
423                         return SR_ERR_ARG;
424                 usb = sdi->conn;
425                 if (usb->address == 255)
426                         /* Device still needs to re-enumerate after firmware
427                          * upload, so we don't know its (future) address. */
428                         return SR_ERR;
429                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
430                 *data = g_variant_new_string(str);
431                 break;
432         case SR_CONF_LIMIT_SAMPLES:
433                 *data = g_variant_new_uint64(devc->limit_samples);
434                 break;
435         case SR_CONF_SAMPLERATE:
436                 *data = g_variant_new_uint64(devc->cur_samplerate);
437                 break;
438         default:
439                 return SR_ERR_NA;
440         }
441
442         return SR_OK;
443 }
444
445 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
446                 const struct sr_channel_group *cg)
447 {
448         struct dev_context *devc;
449         uint64_t arg;
450         unsigned int i;
451         int ret;
452
453         (void)cg;
454
455         if (!sdi)
456                 return SR_ERR_ARG;
457
458         if (sdi->status != SR_ST_ACTIVE)
459                 return SR_ERR;
460
461         devc = sdi->priv;
462
463         ret = SR_OK;
464
465         switch (key) {
466                 case SR_CONF_SAMPLERATE:
467                         arg = g_variant_get_uint64(data);
468                         for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
469                                 if (samplerates[i] == arg) {
470                                         devc->cur_samplerate = arg;
471                                         break;
472                                 }
473                         }
474                         if (i == ARRAY_SIZE(samplerates))
475                                 ret = SR_ERR_ARG;
476                         break;
477                 case SR_CONF_LIMIT_SAMPLES:
478                         devc->limit_samples = g_variant_get_uint64(data);
479                         break;
480                 default:
481                         ret = SR_ERR_NA;
482         }
483
484         return ret;
485 }
486
487 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
488                 const struct sr_channel_group *cg)
489 {
490         GVariant *gvar;
491         GVariantBuilder gvb;
492
493         (void)sdi;
494         (void)cg;
495
496         switch (key) {
497         case SR_CONF_SCAN_OPTIONS:
498                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
499                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
500                 break;
501         case SR_CONF_DEVICE_OPTIONS:
502                 if (!sdi)
503                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
504                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
505                 else
506                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
507                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
508                 break;
509         case SR_CONF_SAMPLERATE:
510                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
511                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
512                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
513                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
514                 *data = g_variant_builder_end(&gvb);
515                 break;
516         case SR_CONF_TRIGGER_MATCH:
517                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
518                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
519                                 sizeof(int32_t));
520                 break;
521         default:
522                 return SR_ERR_NA;
523         }
524
525         return SR_OK;
526 }
527
528 static int receive_data(int fd, int revents, void *cb_data)
529 {
530         struct timeval tv;
531         struct drv_context *drvc;
532
533         (void)fd;
534         (void)revents;
535         (void)cb_data;
536
537         drvc = di->priv;
538
539         tv.tv_sec = tv.tv_usec = 0;
540         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
541
542         return TRUE;
543 }
544
545 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
546 {
547         struct dev_context *devc;
548         struct drv_context *drvc;
549         struct sr_usb_dev_inst *usb;
550         struct sr_trigger *trigger;
551         struct libusb_transfer *transfer;
552         unsigned int i, timeout, num_transfers;
553         int ret;
554         unsigned char *buf;
555         size_t size;
556
557         if (sdi->status != SR_ST_ACTIVE)
558                 return SR_ERR_DEV_CLOSED;
559
560         drvc = di->priv;
561         devc = sdi->priv;
562         usb = sdi->conn;
563
564         devc->cb_data = cb_data;
565         devc->sent_samples = 0;
566         devc->acq_aborted = FALSE;
567         devc->empty_transfer_count = 0;
568
569         if ((trigger = sr_session_trigger_get(sdi->session))) {
570                 devc->stl = soft_trigger_logic_new(sdi, trigger, 0);
571                 devc->trigger_fired = FALSE;
572         } else
573                 devc->trigger_fired = TRUE;
574
575         timeout = fx2lafw_get_timeout(devc);
576         num_transfers = fx2lafw_get_number_of_transfers(devc);
577         size = fx2lafw_get_buffer_size(devc);
578         devc->submitted_transfers = 0;
579
580         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
581         if (!devc->transfers) {
582                 sr_err("USB transfers malloc failed.");
583                 return SR_ERR_MALLOC;
584         }
585
586         devc->num_transfers = num_transfers;
587         for (i = 0; i < num_transfers; i++) {
588                 if (!(buf = g_try_malloc(size))) {
589                         sr_err("USB transfer buffer malloc failed.");
590                         return SR_ERR_MALLOC;
591                 }
592                 transfer = libusb_alloc_transfer(0);
593                 libusb_fill_bulk_transfer(transfer, usb->devhdl,
594                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
595                                 fx2lafw_receive_transfer, (void *)sdi, timeout);
596                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
597                         sr_err("Failed to submit transfer: %s.",
598                                libusb_error_name(ret));
599                         libusb_free_transfer(transfer);
600                         g_free(buf);
601                         fx2lafw_abort_acquisition(devc);
602                         return SR_ERR;
603                 }
604                 devc->transfers[i] = transfer;
605                 devc->submitted_transfers++;
606         }
607
608         devc->ctx = drvc->sr_ctx;
609
610         usb_source_add(sdi->session, devc->ctx, timeout, receive_data, NULL);
611
612         /* Send header packet to the session bus. */
613         std_session_send_df_header(cb_data, LOG_PREFIX);
614
615         if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
616                 fx2lafw_abort_acquisition(devc);
617                 return ret;
618         }
619
620         return SR_OK;
621 }
622
623 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
624 {
625         (void)cb_data;
626
627         fx2lafw_abort_acquisition(sdi->priv);
628
629         return SR_OK;
630 }
631
632 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
633         .name = "fx2lafw",
634         .longname = "fx2lafw (generic driver for FX2 based LAs)",
635         .api_version = 1,
636         .init = init,
637         .cleanup = cleanup,
638         .scan = scan,
639         .dev_list = dev_list,
640         .dev_clear = NULL,
641         .config_get = config_get,
642         .config_set = config_set,
643         .config_list = config_list,
644         .dev_open = dev_open,
645         .dev_close = dev_close,
646         .dev_acquisition_start = dev_acquisition_start,
647         .dev_acquisition_stop = dev_acquisition_stop,
648         .priv = NULL,
649 };