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/>.
23 static const struct fx2lafw_profile supported_fx2[] = {
26 * EE Electronics ESLA201A
29 { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
30 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
36 { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
37 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
43 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
44 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
49 * EE Electronics ESLA100
51 * Robomotic BugLogic 3
53 { 0x0925, 0x3881, "Saleae", "Logic", NULL,
54 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
58 * Default Cypress FX2 without EEPROM, e.g.:
60 * Braintechnology USB Interface V2.x
62 { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
63 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
67 * Braintechnology USB-LPS
69 { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
70 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
73 { 0, 0, 0, 0, 0, 0, 0 }
76 static const int32_t hwopts[] = {
80 static const int32_t hwcaps[] = {
81 SR_CONF_LOGIC_ANALYZER,
85 /* These are really implemented in the driver, not the hardware. */
86 SR_CONF_LIMIT_SAMPLES,
90 static const char *channel_names[] = {
91 "0", "1", "2", "3", "4", "5", "6", "7",
92 "8", "9", "10", "11", "12", "13", "14", "15",
96 static const uint64_t samplerates[] = {
115 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
116 static struct sr_dev_driver *di = &fx2lafw_driver_info;
118 static int init(struct sr_context *sr_ctx)
120 return std_init(sr_ctx, di, LOG_PREFIX);
123 static GSList *scan(GSList *options)
125 struct drv_context *drvc;
126 struct dev_context *devc;
127 struct sr_dev_inst *sdi;
128 struct sr_usb_dev_inst *usb;
129 struct sr_channel *ch;
130 struct sr_config *src;
131 const struct fx2lafw_profile *prof;
132 GSList *l, *devices, *conn_devices;
133 struct libusb_device_descriptor des;
134 libusb_device **devlist;
135 int devcnt, num_logic_channels, ret, i, j;
141 for (l = options; l; l = l->next) {
145 conn = g_variant_get_string(src->data, NULL);
150 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
154 /* Find all fx2lafw compatible devices and upload firmware to them. */
156 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
157 for (i = 0; devlist[i]; i++) {
160 for (l = conn_devices; l; l = l->next) {
162 if (usb->bus == libusb_get_bus_number(devlist[i])
163 && usb->address == libusb_get_device_address(devlist[i]))
167 /* This device matched none of the ones that
168 * matched the conn specification. */
172 if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
173 sr_warn("Failed to get device descriptor: %s.",
174 libusb_error_name(ret));
179 for (j = 0; supported_fx2[j].vid; j++) {
180 if (des.idVendor == supported_fx2[j].vid &&
181 des.idProduct == supported_fx2[j].pid) {
182 prof = &supported_fx2[j];
186 /* Skip if the device was not found. */
190 devcnt = g_slist_length(drvc->instances);
191 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
192 prof->vendor, prof->model, prof->model_version);
197 /* Fill in channellist according to this device's profile. */
198 num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
199 for (j = 0; j < num_logic_channels; j++) {
200 if (!(ch = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
203 sdi->channels = g_slist_append(sdi->channels, ch);
206 devc = fx2lafw_dev_new();
207 devc->profile = prof;
209 drvc->instances = g_slist_append(drvc->instances, sdi);
210 devices = g_slist_append(devices, sdi);
212 if (fx2lafw_check_conf_profile(devlist[i])) {
213 /* Already has the firmware, so fix the new address. */
214 sr_dbg("Found an fx2lafw device.");
215 sdi->status = SR_ST_INACTIVE;
216 sdi->inst_type = SR_INST_USB;
217 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
218 libusb_get_device_address(devlist[i]), NULL);
220 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
221 prof->firmware) == SR_OK)
222 /* Store when this device's FW was updated. */
223 devc->fw_updated = g_get_monotonic_time();
225 sr_err("Firmware upload failed for "
226 "device %d.", devcnt);
227 sdi->inst_type = SR_INST_USB;
228 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
232 libusb_free_device_list(devlist, 1);
233 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
238 static GSList *dev_list(void)
240 return ((struct drv_context *)(di->priv))->instances;
243 static int dev_open(struct sr_dev_inst *sdi)
245 struct sr_usb_dev_inst *usb;
246 struct dev_context *devc;
248 int64_t timediff_us, timediff_ms;
254 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
255 * milliseconds for the FX2 to renumerate.
258 if (devc->fw_updated > 0) {
259 sr_info("Waiting for device to reset.");
260 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
261 g_usleep(300 * 1000);
263 while (timediff_ms < MAX_RENUM_DELAY_MS) {
264 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
266 g_usleep(100 * 1000);
268 timediff_us = g_get_monotonic_time() - devc->fw_updated;
269 timediff_ms = timediff_us / 1000;
270 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
273 sr_err("Device failed to renumerate.");
276 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
278 sr_info("Firmware upload was not needed.");
279 ret = fx2lafw_dev_open(sdi, di);
283 sr_err("Unable to open device.");
287 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
290 case LIBUSB_ERROR_BUSY:
291 sr_err("Unable to claim USB interface. Another "
292 "program or driver has already claimed it.");
294 case LIBUSB_ERROR_NO_DEVICE:
295 sr_err("Device has been disconnected.");
298 sr_err("Unable to claim interface: %s.",
299 libusb_error_name(ret));
306 if (devc->cur_samplerate == 0) {
307 /* Samplerate hasn't been set; default to the slowest one. */
308 devc->cur_samplerate = samplerates[0];
314 static int dev_close(struct sr_dev_inst *sdi)
316 struct sr_usb_dev_inst *usb;
319 if (usb->devhdl == NULL)
322 sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
323 sdi->index, usb->bus, usb->address, USB_INTERFACE);
324 libusb_release_interface(usb->devhdl, USB_INTERFACE);
325 libusb_close(usb->devhdl);
327 sdi->status = SR_ST_INACTIVE;
332 static int cleanup(void)
335 struct drv_context *drvc;
337 if (!(drvc = di->priv))
341 ret = std_dev_clear(di, NULL);
349 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
350 const struct sr_channel_group *cg)
352 struct dev_context *devc;
353 struct sr_usb_dev_inst *usb;
360 if (!sdi || !sdi->conn)
363 if (usb->address == 255)
364 /* Device still needs to re-enumerate after firmware
365 * upload, so we don't know its (future) address. */
367 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
368 *data = g_variant_new_string(str);
370 case SR_CONF_SAMPLERATE:
374 *data = g_variant_new_uint64(devc->cur_samplerate);
383 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
384 const struct sr_channel_group *cg)
386 struct dev_context *devc;
391 if (sdi->status != SR_ST_ACTIVE)
396 if (id == SR_CONF_SAMPLERATE) {
397 devc->cur_samplerate = g_variant_get_uint64(data);
399 } else if (id == SR_CONF_LIMIT_SAMPLES) {
400 devc->limit_samples = g_variant_get_uint64(data);
409 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
410 const struct sr_channel_group *cg)
419 case SR_CONF_SCAN_OPTIONS:
420 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
421 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
423 case SR_CONF_DEVICE_OPTIONS:
424 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
425 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
427 case SR_CONF_SAMPLERATE:
428 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
429 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
430 ARRAY_SIZE(samplerates), sizeof(uint64_t));
431 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
432 *data = g_variant_builder_end(&gvb);
434 case SR_CONF_TRIGGER_TYPE:
435 *data = g_variant_new_string(TRIGGER_TYPE);
444 static int receive_data(int fd, int revents, void *cb_data)
447 struct drv_context *drvc;
455 tv.tv_sec = tv.tv_usec = 0;
456 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
461 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
463 struct dev_context *devc;
464 struct drv_context *drvc;
465 struct sr_usb_dev_inst *usb;
466 struct libusb_transfer *transfer;
467 unsigned int i, timeout, num_transfers;
472 if (sdi->status != SR_ST_ACTIVE)
473 return SR_ERR_DEV_CLOSED;
479 /* Configures devc->trigger_* and devc->sample_wide */
480 if (fx2lafw_configure_channels(sdi) != SR_OK) {
481 sr_err("Failed to configure channels.");
485 devc->cb_data = cb_data;
486 devc->num_samples = 0;
487 devc->empty_transfer_count = 0;
489 timeout = fx2lafw_get_timeout(devc);
490 num_transfers = fx2lafw_get_number_of_transfers(devc);
491 size = fx2lafw_get_buffer_size(devc);
492 devc->submitted_transfers = 0;
494 devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
495 if (!devc->transfers) {
496 sr_err("USB transfers malloc failed.");
497 return SR_ERR_MALLOC;
500 devc->num_transfers = num_transfers;
501 for (i = 0; i < num_transfers; i++) {
502 if (!(buf = g_try_malloc(size))) {
503 sr_err("USB transfer buffer malloc failed.");
504 return SR_ERR_MALLOC;
506 transfer = libusb_alloc_transfer(0);
507 libusb_fill_bulk_transfer(transfer, usb->devhdl,
508 2 | LIBUSB_ENDPOINT_IN, buf, size,
509 fx2lafw_receive_transfer, devc, timeout);
510 if ((ret = libusb_submit_transfer(transfer)) != 0) {
511 sr_err("Failed to submit transfer: %s.",
512 libusb_error_name(ret));
513 libusb_free_transfer(transfer);
515 fx2lafw_abort_acquisition(devc);
518 devc->transfers[i] = transfer;
519 devc->submitted_transfers++;
522 devc->ctx = drvc->sr_ctx;
524 usb_source_add(devc->ctx, timeout, receive_data, NULL);
526 /* Send header packet to the session bus. */
527 std_session_send_df_header(cb_data, LOG_PREFIX);
529 if ((ret = fx2lafw_command_start_acquisition(usb->devhdl,
530 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
531 fx2lafw_abort_acquisition(devc);
538 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
542 fx2lafw_abort_acquisition(sdi->priv);
547 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
549 .longname = "fx2lafw (generic driver for FX2 based LAs)",
554 .dev_list = dev_list,
556 .config_get = config_get,
557 .config_set = config_set,
558 .config_list = config_list,
559 .dev_open = dev_open,
560 .dev_close = dev_close,
561 .dev_acquisition_start = dev_acquisition_start,
562 .dev_acquisition_stop = dev_acquisition_stop,