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