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