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