]> sigrok.org Git - libsigrok.git/blob - src/hardware/fx2lafw/api.c
fx2lafw: Publish driver options.
[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 = sr_dev_inst_new();
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                         if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
257                                         channel_names[j])))
258                                 return NULL;
259                         sdi->channels = g_slist_append(sdi->channels, ch);
260                 }
261
262                 devc = fx2lafw_dev_new();
263                 devc->profile = prof;
264                 devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
265                 sdi->priv = devc;
266                 drvc->instances = g_slist_append(drvc->instances, sdi);
267                 devices = g_slist_append(devices, sdi);
268
269                 if (fx2lafw_check_conf_profile(devlist[i])) {
270                         /* Already has the firmware, so fix the new address. */
271                         sr_dbg("Found an fx2lafw device.");
272                         sdi->status = SR_ST_INACTIVE;
273                         sdi->inst_type = SR_INST_USB;
274                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
275                                         libusb_get_device_address(devlist[i]), NULL);
276                 } else {
277                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
278                                 prof->firmware) == SR_OK)
279                                 /* Store when this device's FW was updated. */
280                                 devc->fw_updated = g_get_monotonic_time();
281                         else
282                                 sr_err("Firmware upload failed for "
283                                        "device %d.%d (logical).",
284                                        libusb_get_bus_number(devlist[i]),
285                                        libusb_get_device_address(devlist[i]));
286                         sdi->inst_type = SR_INST_USB;
287                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
288                                         0xff, NULL);
289                 }
290         }
291         libusb_free_device_list(devlist, 1);
292         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
293
294         return devices;
295 }
296
297 static GSList *dev_list(void)
298 {
299         return ((struct drv_context *)(di->priv))->instances;
300 }
301
302 static int dev_open(struct sr_dev_inst *sdi)
303 {
304         struct sr_usb_dev_inst *usb;
305         struct dev_context *devc;
306         int ret;
307         int64_t timediff_us, timediff_ms;
308
309         devc = sdi->priv;
310         usb = sdi->conn;
311
312         /*
313          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
314          * milliseconds for the FX2 to renumerate.
315          */
316         ret = SR_ERR;
317         if (devc->fw_updated > 0) {
318                 sr_info("Waiting for device to reset.");
319                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
320                 g_usleep(300 * 1000);
321                 timediff_ms = 0;
322                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
323                         if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
324                                 break;
325                         g_usleep(100 * 1000);
326
327                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
328                         timediff_ms = timediff_us / 1000;
329                         sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
330                 }
331                 if (ret != SR_OK) {
332                         sr_err("Device failed to renumerate.");
333                         return SR_ERR;
334                 }
335                 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
336         } else {
337                 sr_info("Firmware upload was not needed.");
338                 ret = fx2lafw_dev_open(sdi, di);
339         }
340
341         if (ret != SR_OK) {
342                 sr_err("Unable to open device.");
343                 return SR_ERR;
344         }
345
346         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
347         if (ret != 0) {
348                 switch (ret) {
349                 case LIBUSB_ERROR_BUSY:
350                         sr_err("Unable to claim USB interface. Another "
351                                "program or driver has already claimed it.");
352                         break;
353                 case LIBUSB_ERROR_NO_DEVICE:
354                         sr_err("Device has been disconnected.");
355                         break;
356                 default:
357                         sr_err("Unable to claim interface: %s.",
358                                libusb_error_name(ret));
359                         break;
360                 }
361
362                 return SR_ERR;
363         }
364
365         if (devc->cur_samplerate == 0) {
366                 /* Samplerate hasn't been set; default to the slowest one. */
367                 devc->cur_samplerate = samplerates[0];
368         }
369
370         return SR_OK;
371 }
372
373 static int dev_close(struct sr_dev_inst *sdi)
374 {
375         struct sr_usb_dev_inst *usb;
376
377         usb = sdi->conn;
378         if (usb->devhdl == NULL)
379                 return SR_ERR;
380
381         sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
382                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
383         libusb_release_interface(usb->devhdl, USB_INTERFACE);
384         libusb_close(usb->devhdl);
385         usb->devhdl = NULL;
386         sdi->status = SR_ST_INACTIVE;
387
388         return SR_OK;
389 }
390
391 static int cleanup(void)
392 {
393         int ret;
394         struct drv_context *drvc;
395
396         if (!(drvc = di->priv))
397                 return SR_OK;
398
399         ret = std_dev_clear(di, NULL);
400
401         g_free(drvc);
402         di->priv = NULL;
403
404         return ret;
405 }
406
407 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
408                 const struct sr_channel_group *cg)
409 {
410         struct dev_context *devc;
411         struct sr_usb_dev_inst *usb;
412         char str[128];
413
414         (void)cg;
415
416         if (!sdi)
417                 return SR_ERR_ARG;
418
419         devc = sdi->priv;
420
421         switch (key) {
422         case SR_CONF_CONN:
423                 if (!sdi->conn)
424                         return SR_ERR_ARG;
425                 usb = sdi->conn;
426                 if (usb->address == 255)
427                         /* Device still needs to re-enumerate after firmware
428                          * upload, so we don't know its (future) address. */
429                         return SR_ERR;
430                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
431                 *data = g_variant_new_string(str);
432                 break;
433         case SR_CONF_LIMIT_SAMPLES:
434                 *data = g_variant_new_uint64(devc->limit_samples);
435                 break;
436         case SR_CONF_SAMPLERATE:
437                 *data = g_variant_new_uint64(devc->cur_samplerate);
438                 break;
439         default:
440                 return SR_ERR_NA;
441         }
442
443         return SR_OK;
444 }
445
446 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
447                 const struct sr_channel_group *cg)
448 {
449         struct dev_context *devc;
450         uint64_t arg;
451         unsigned int i;
452         int ret;
453
454         (void)cg;
455
456         if (!sdi)
457                 return SR_ERR_ARG;
458
459         if (sdi->status != SR_ST_ACTIVE)
460                 return SR_ERR;
461
462         devc = sdi->priv;
463
464         ret = SR_OK;
465
466         switch (key) {
467                 case SR_CONF_SAMPLERATE:
468                         arg = g_variant_get_uint64(data);
469                         for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
470                                 if (samplerates[i] == arg) {
471                                         devc->cur_samplerate = arg;
472                                         break;
473                                 }
474                         }
475                         if (i == ARRAY_SIZE(samplerates))
476                                 ret = SR_ERR_ARG;
477                         break;
478                 case SR_CONF_LIMIT_SAMPLES:
479                         devc->limit_samples = g_variant_get_uint64(data);
480                         break;
481                 default:
482                         ret = SR_ERR_NA;
483         }
484
485         return ret;
486 }
487
488 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
489                 const struct sr_channel_group *cg)
490 {
491         GVariant *gvar;
492         GVariantBuilder gvb;
493
494         (void)sdi;
495         (void)cg;
496
497         switch (key) {
498         case SR_CONF_SCAN_OPTIONS:
499                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
500                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
501                 break;
502         case SR_CONF_DEVICE_OPTIONS:
503                 if (!sdi)
504                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
505                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
506                 else
507                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
508                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
509                 break;
510         case SR_CONF_SAMPLERATE:
511                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
512                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
513                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
514                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
515                 *data = g_variant_builder_end(&gvb);
516                 break;
517         case SR_CONF_TRIGGER_MATCH:
518                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
519                                 soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
520                                 sizeof(int32_t));
521                 break;
522         default:
523                 return SR_ERR_NA;
524         }
525
526         return SR_OK;
527 }
528
529 static int receive_data(int fd, int revents, void *cb_data)
530 {
531         struct timeval tv;
532         struct drv_context *drvc;
533
534         (void)fd;
535         (void)revents;
536         (void)cb_data;
537
538         drvc = di->priv;
539
540         tv.tv_sec = tv.tv_usec = 0;
541         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
542
543         return TRUE;
544 }
545
546 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
547 {
548         struct dev_context *devc;
549         struct drv_context *drvc;
550         struct sr_usb_dev_inst *usb;
551         struct sr_trigger *trigger;
552         struct libusb_transfer *transfer;
553         unsigned int i, timeout, num_transfers;
554         int ret;
555         unsigned char *buf;
556         size_t size;
557
558         if (sdi->status != SR_ST_ACTIVE)
559                 return SR_ERR_DEV_CLOSED;
560
561         drvc = di->priv;
562         devc = sdi->priv;
563         usb = sdi->conn;
564
565         devc->cb_data = cb_data;
566         devc->sent_samples = 0;
567         devc->acq_aborted = FALSE;
568         devc->empty_transfer_count = 0;
569
570         if ((trigger = sr_session_trigger_get(sdi->session))) {
571                 devc->stl = soft_trigger_logic_new(sdi, trigger);
572                 devc->trigger_fired = FALSE;
573         } else
574                 devc->trigger_fired = TRUE;
575
576         timeout = fx2lafw_get_timeout(devc);
577         num_transfers = fx2lafw_get_number_of_transfers(devc);
578         size = fx2lafw_get_buffer_size(devc);
579         devc->submitted_transfers = 0;
580
581         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
582         if (!devc->transfers) {
583                 sr_err("USB transfers malloc failed.");
584                 return SR_ERR_MALLOC;
585         }
586
587         devc->num_transfers = num_transfers;
588         for (i = 0; i < num_transfers; i++) {
589                 if (!(buf = g_try_malloc(size))) {
590                         sr_err("USB transfer buffer malloc failed.");
591                         return SR_ERR_MALLOC;
592                 }
593                 transfer = libusb_alloc_transfer(0);
594                 libusb_fill_bulk_transfer(transfer, usb->devhdl,
595                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
596                                 fx2lafw_receive_transfer, (void *)sdi, timeout);
597                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
598                         sr_err("Failed to submit transfer: %s.",
599                                libusb_error_name(ret));
600                         libusb_free_transfer(transfer);
601                         g_free(buf);
602                         fx2lafw_abort_acquisition(devc);
603                         return SR_ERR;
604                 }
605                 devc->transfers[i] = transfer;
606                 devc->submitted_transfers++;
607         }
608
609         devc->ctx = drvc->sr_ctx;
610
611         usb_source_add(sdi->session, devc->ctx, timeout, receive_data, NULL);
612
613         /* Send header packet to the session bus. */
614         std_session_send_df_header(cb_data, LOG_PREFIX);
615
616         if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
617                 fx2lafw_abort_acquisition(devc);
618                 return ret;
619         }
620
621         return SR_OK;
622 }
623
624 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
625 {
626         (void)cb_data;
627
628         fx2lafw_abort_acquisition(sdi->priv);
629
630         return SR_OK;
631 }
632
633 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
634         .name = "fx2lafw",
635         .longname = "fx2lafw (generic driver for FX2 based LAs)",
636         .api_version = 1,
637         .init = init,
638         .cleanup = cleanup,
639         .scan = scan,
640         .dev_list = dev_list,
641         .dev_clear = NULL,
642         .config_get = config_get,
643         .config_set = config_set,
644         .config_list = config_list,
645         .dev_open = dev_open,
646         .dev_close = dev_close,
647         .dev_acquisition_start = dev_acquisition_start,
648         .dev_acquisition_stop = dev_acquisition_stop,
649         .priv = NULL,
650 };