2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
25 static const struct fx2lafw_profile supported_fx2[] = {
28 * ARMFLY AX-Pro (clone of the CWAV USBee AX)
29 * ARMFLY Mini-Logic (clone of the CWAV USBee AX)
30 * EE Electronics ESLA201A (clone of the CWAV USBee AX)
31 * HT USBee-AxPro (clone of the CWAV USBee AX)
32 * MCU123 USBee AX Pro clone (clone of the CWAV USBee AX)
33 * Noname LHT00SU1 (clone of the CWAV USBee AX)
34 * XZL_Studio AX (clone of the CWAV USBee AX)
36 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
37 "fx2lafw-cwav-usbeeax.fw",
38 DEV_CAPS_AX_ANALOG, NULL, NULL},
42 * HT USBee-DxPro (clone of the CWAV USBee DX), not yet supported!
43 * XZL-Studio DX (clone of the CWAV USBee DX)
45 { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
46 "fx2lafw-cwav-usbeedx.fw",
47 DEV_CAPS_16BIT, NULL, NULL },
52 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
53 "fx2lafw-cwav-usbeesx.fw",
59 { 0x08a9, 0x0005, "CWAV", "USBee ZX", NULL,
60 "fx2lafw-cwav-usbeezx.fw",
65 * EE Electronics ESLA100 (clone of the Saleae Logic)
66 * Hantek 6022BL in LA mode (clone of the Saleae Logic)
67 * Instrustar ISDS205X in LA mode (clone of the Saleae Logic)
68 * Robomotic MiniLogic (clone of the Saleae Logic)
69 * Robomotic BugLogic 3 (clone of the Saleae Logic)
70 * MCU123 Saleae Logic clone (clone of the Saleae Logic)
72 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
73 "fx2lafw-saleae-logic.fw",
77 * Default Cypress FX2 without EEPROM, e.g.:
79 * Braintechnology USB Interface V2.x
82 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
83 "fx2lafw-cypress-fx2.fw",
84 DEV_CAPS_16BIT, NULL, NULL },
87 * Braintechnology USB-LPS
89 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
90 "fx2lafw-braintechnology-usb-lps.fw",
91 DEV_CAPS_16BIT, NULL, NULL },
94 * sigrok FX2 based 8-channel logic analyzer
95 * fx2grok-flat (before and after renumeration)
97 { 0x1d50, 0x608c, "sigrok", "FX2 LA (8ch)", NULL,
98 "fx2lafw-sigrok-fx2-8ch.fw",
102 * sigrok FX2 based 16-channel logic analyzer
104 { 0x1d50, 0x608d, "sigrok", "FX2 LA (16ch)", NULL,
105 "fx2lafw-sigrok-fx2-16ch.fw",
106 DEV_CAPS_16BIT, NULL, NULL },
111 static const uint32_t scanopts[] = {
115 static const uint32_t drvopts[] = {
116 SR_CONF_LOGIC_ANALYZER,
119 static const uint32_t devopts[] = {
121 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
122 SR_CONF_CONN | SR_CONF_GET,
123 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
124 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
125 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
128 static const int32_t trigger_matches[] = {
136 static const uint64_t samplerates[] = {
155 static gboolean is_plausible(const struct libusb_device_descriptor *des)
159 for (i = 0; supported_fx2[i].vid; i++) {
160 if (des->idVendor != supported_fx2[i].vid)
162 if (des->idProduct == supported_fx2[i].pid)
169 static GSList *scan(struct sr_dev_driver *di, GSList *options)
171 struct drv_context *drvc;
172 struct dev_context *devc;
173 struct sr_dev_inst *sdi;
174 struct sr_usb_dev_inst *usb;
175 struct sr_channel *ch;
176 struct sr_channel_group *cg;
177 struct sr_config *src;
178 const struct fx2lafw_profile *prof;
179 GSList *l, *devices, *conn_devices;
180 gboolean has_firmware;
181 struct libusb_device_descriptor des;
182 libusb_device **devlist;
183 struct libusb_device_handle *hdl;
185 int num_logic_channels = 0, num_analog_channels = 0;
187 char manufacturer[64], product[64], serial_num[64], connection_id[64];
188 char channel_name[16];
193 for (l = options; l; l = l->next) {
197 conn = g_variant_get_string(src->data, NULL);
202 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
206 /* Find all fx2lafw compatible devices and upload firmware to them. */
208 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
209 for (i = 0; devlist[i]; i++) {
212 for (l = conn_devices; l; l = l->next) {
214 if (usb->bus == libusb_get_bus_number(devlist[i])
215 && usb->address == libusb_get_device_address(devlist[i]))
219 /* This device matched none of the ones that
220 * matched the conn specification. */
224 libusb_get_device_descriptor( devlist[i], &des);
226 if (!is_plausible(&des))
229 if ((ret = libusb_open(devlist[i], &hdl)) < 0) {
230 sr_warn("Failed to open potential device with "
231 "VID:PID %04x:%04x: %s.", des.idVendor,
232 des.idProduct, libusb_error_name(ret));
236 if (des.iManufacturer == 0) {
237 manufacturer[0] = '\0';
238 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
239 des.iManufacturer, (unsigned char *) manufacturer,
240 sizeof(manufacturer))) < 0) {
241 sr_warn("Failed to get manufacturer string descriptor: %s.",
242 libusb_error_name(ret));
246 if (des.iProduct == 0) {
248 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
249 des.iProduct, (unsigned char *) product,
250 sizeof(product))) < 0) {
251 sr_warn("Failed to get product string descriptor: %s.",
252 libusb_error_name(ret));
256 if (des.iSerialNumber == 0) {
257 serial_num[0] = '\0';
258 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
259 des.iSerialNumber, (unsigned char *) serial_num,
260 sizeof(serial_num))) < 0) {
261 sr_warn("Failed to get serial number string descriptor: %s.",
262 libusb_error_name(ret));
266 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
271 for (j = 0; supported_fx2[j].vid; j++) {
272 if (des.idVendor == supported_fx2[j].vid &&
273 des.idProduct == supported_fx2[j].pid &&
274 (!supported_fx2[j].usb_manufacturer ||
275 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
276 (!supported_fx2[j].usb_product ||
277 !strcmp(product, supported_fx2[j].usb_product))) {
278 prof = &supported_fx2[j];
286 sdi = g_malloc0(sizeof(struct sr_dev_inst));
287 sdi->status = SR_ST_INITIALIZING;
288 sdi->vendor = g_strdup(prof->vendor);
289 sdi->model = g_strdup(prof->model);
290 sdi->version = g_strdup(prof->model_version);
291 sdi->serial_num = g_strdup(serial_num);
292 sdi->connection_id = g_strdup(connection_id);
294 /* Fill in channellist according to this device's profile. */
295 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
296 num_analog_channels = prof->dev_caps & DEV_CAPS_AX_ANALOG ? 1 : 0;
298 /* Logic channels, all in one channel group. */
299 cg = g_malloc0(sizeof(struct sr_channel_group));
300 cg->name = g_strdup("Logic");
301 for (j = 0; j < num_logic_channels; j++) {
302 sprintf(channel_name, "D%d", j);
303 ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
305 cg->channels = g_slist_append(cg->channels, ch);
307 sdi->channel_groups = g_slist_append(NULL, cg);
309 for (j = 0; j < num_analog_channels; j++) {
310 snprintf(channel_name, 16, "A%d", j);
311 ch = sr_channel_new(sdi, j + num_logic_channels,
312 SR_CHANNEL_ANALOG, TRUE, channel_name);
314 /* Every analog channel gets its own channel group. */
315 cg = g_malloc0(sizeof(struct sr_channel_group));
316 cg->name = g_strdup(channel_name);
317 cg->channels = g_slist_append(NULL, ch);
318 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
321 devc = fx2lafw_dev_new();
322 devc->profile = prof;
324 devices = g_slist_append(devices, sdi);
326 devc->samplerates = samplerates;
327 devc->num_samplerates = ARRAY_SIZE(samplerates);
328 has_firmware = usb_match_manuf_prod(devlist[i],
329 "sigrok", "fx2lafw");
332 /* Already has the firmware, so fix the new address. */
333 sr_dbg("Found an fx2lafw device.");
334 sdi->status = SR_ST_INACTIVE;
335 sdi->inst_type = SR_INST_USB;
336 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
337 libusb_get_device_address(devlist[i]), NULL);
339 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
340 USB_CONFIGURATION, prof->firmware) == SR_OK)
341 /* Store when this device's FW was updated. */
342 devc->fw_updated = g_get_monotonic_time();
344 sr_err("Firmware upload failed for "
345 "device %d.%d (logical).",
346 libusb_get_bus_number(devlist[i]),
347 libusb_get_device_address(devlist[i]));
348 sdi->inst_type = SR_INST_USB;
349 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
353 libusb_free_device_list(devlist, 1);
354 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
356 return std_scan_complete(di, devices);
359 static void clear_helper(struct dev_context *devc)
361 g_slist_free(devc->enabled_analog_channels);
364 static int dev_clear(const struct sr_dev_driver *di)
366 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
369 static int dev_open(struct sr_dev_inst *sdi)
371 struct sr_dev_driver *di = sdi->driver;
372 struct sr_usb_dev_inst *usb;
373 struct dev_context *devc;
375 int64_t timediff_us, timediff_ms;
381 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
382 * milliseconds for the FX2 to renumerate.
385 if (devc->fw_updated > 0) {
386 sr_info("Waiting for device to reset.");
387 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
388 g_usleep(300 * 1000);
390 while (timediff_ms < MAX_RENUM_DELAY_MS) {
391 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
393 g_usleep(100 * 1000);
395 timediff_us = g_get_monotonic_time() - devc->fw_updated;
396 timediff_ms = timediff_us / 1000;
397 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
400 sr_err("Device failed to renumerate.");
403 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
405 sr_info("Firmware upload was not needed.");
406 ret = fx2lafw_dev_open(sdi, di);
410 sr_err("Unable to open device.");
414 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
417 case LIBUSB_ERROR_BUSY:
418 sr_err("Unable to claim USB interface. Another "
419 "program or driver has already claimed it.");
421 case LIBUSB_ERROR_NO_DEVICE:
422 sr_err("Device has been disconnected.");
425 sr_err("Unable to claim interface: %s.",
426 libusb_error_name(ret));
433 if (devc->cur_samplerate == 0) {
434 /* Samplerate hasn't been set; default to the slowest one. */
435 devc->cur_samplerate = devc->samplerates[0];
441 static int dev_close(struct sr_dev_inst *sdi)
443 struct sr_usb_dev_inst *usb;
450 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
451 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
452 libusb_release_interface(usb->devhdl, USB_INTERFACE);
453 libusb_close(usb->devhdl);
459 static int config_get(uint32_t key, GVariant **data,
460 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
462 struct dev_context *devc;
463 struct sr_usb_dev_inst *usb;
477 if (usb->address == 255)
478 /* Device still needs to re-enumerate after firmware
479 * upload, so we don't know its (future) address. */
481 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
483 case SR_CONF_LIMIT_SAMPLES:
484 *data = g_variant_new_uint64(devc->limit_samples);
486 case SR_CONF_SAMPLERATE:
487 *data = g_variant_new_uint64(devc->cur_samplerate);
489 case SR_CONF_CAPTURE_RATIO:
490 *data = g_variant_new_uint64(devc->capture_ratio);
499 static int config_set(uint32_t key, GVariant *data,
500 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
502 struct dev_context *devc;
513 case SR_CONF_SAMPLERATE:
514 if ((idx = std_u64_idx(data, devc->samplerates, devc->num_samplerates)) < 0)
516 devc->cur_samplerate = devc->samplerates[idx];
518 case SR_CONF_LIMIT_SAMPLES:
519 devc->limit_samples = g_variant_get_uint64(data);
521 case SR_CONF_CAPTURE_RATIO:
522 devc->capture_ratio = g_variant_get_uint64(data);
531 static int config_list(uint32_t key, GVariant **data,
532 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
534 struct dev_context *devc;
536 devc = (sdi) ? sdi->priv : NULL;
539 case SR_CONF_SCAN_OPTIONS:
540 case SR_CONF_DEVICE_OPTIONS:
541 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
542 case SR_CONF_SAMPLERATE:
543 *data = std_gvar_samplerates(devc->samplerates, devc->num_samplerates);
545 case SR_CONF_TRIGGER_MATCH:
546 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
555 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
557 fx2lafw_abort_acquisition(sdi->priv);
562 static struct sr_dev_driver fx2lafw_driver_info = {
564 .longname = "fx2lafw (generic driver for FX2 based LAs)",
567 .cleanup = std_cleanup,
569 .dev_list = std_dev_list,
570 .dev_clear = dev_clear,
571 .config_get = config_get,
572 .config_set = config_set,
573 .config_list = config_list,
574 .dev_open = dev_open,
575 .dev_close = dev_close,
576 .dev_acquisition_start = fx2lafw_start_acquisition,
577 .dev_acquisition_stop = dev_acquisition_stop,
580 SR_REGISTER_DEV_DRIVER(fx2lafw_driver_info);