]> sigrok.org Git - libsigrok.git/blame_incremental - hardware/fx2lafw/api.c
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / hardware / fx2lafw / api.c
... / ...
CommitLineData
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
23static 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 },
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 },
39
40 /*
41 * CWAV USBee SX
42 */
43 { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
44 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
45 0 },
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 },
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 },
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 },
72
73 { 0, 0, 0, 0, 0, 0, 0 }
74};
75
76static const int32_t hwopts[] = {
77 SR_CONF_CONN,
78};
79
80static const int32_t hwcaps[] = {
81 SR_CONF_LOGIC_ANALYZER,
82 SR_CONF_TRIGGER_TYPE,
83 SR_CONF_SAMPLERATE,
84
85 /* These are really implemented in the driver, not the hardware. */
86 SR_CONF_LIMIT_SAMPLES,
87 SR_CONF_CONTINUOUS,
88};
89
90static const char *channel_names[] = {
91 "0", "1", "2", "3", "4", "5", "6", "7",
92 "8", "9", "10", "11", "12", "13", "14", "15",
93 NULL,
94};
95
96static const uint64_t samplerates[] = {
97 SR_KHZ(20),
98 SR_KHZ(25),
99 SR_KHZ(50),
100 SR_KHZ(100),
101 SR_KHZ(200),
102 SR_KHZ(250),
103 SR_KHZ(500),
104 SR_MHZ(1),
105 SR_MHZ(2),
106 SR_MHZ(3),
107 SR_MHZ(4),
108 SR_MHZ(6),
109 SR_MHZ(8),
110 SR_MHZ(12),
111 SR_MHZ(16),
112 SR_MHZ(24),
113};
114
115SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
116static struct sr_dev_driver *di = &fx2lafw_driver_info;
117
118static int init(struct sr_context *sr_ctx)
119{
120 return std_init(sr_ctx, di, LOG_PREFIX);
121}
122
123static GSList *scan(GSList *options)
124{
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;
136 const char *conn;
137
138 drvc = di->priv;
139
140 conn = NULL;
141 for (l = options; l; l = l->next) {
142 src = l->data;
143 switch (src->key) {
144 case SR_CONF_CONN:
145 conn = g_variant_get_string(src->data, NULL);
146 break;
147 }
148 }
149 if (conn)
150 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
151 else
152 conn_devices = NULL;
153
154 /* Find all fx2lafw compatible devices and upload firmware to them. */
155 devices = NULL;
156 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
157 for (i = 0; devlist[i]; i++) {
158 if (conn) {
159 usb = NULL;
160 for (l = conn_devices; l; l = l->next) {
161 usb = l->data;
162 if (usb->bus == libusb_get_bus_number(devlist[i])
163 && usb->address == libusb_get_device_address(devlist[i]))
164 break;
165 }
166 if (!l)
167 /* This device matched none of the ones that
168 * matched the conn specification. */
169 continue;
170 }
171
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));
175 continue;
176 }
177
178 prof = NULL;
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];
183 }
184 }
185
186 /* Skip if the device was not found. */
187 if (!prof)
188 continue;
189
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);
193 if (!sdi)
194 return NULL;
195 sdi->driver = di;
196
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_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
201 channel_names[j])))
202 return NULL;
203 sdi->channels = g_slist_append(sdi->channels, ch);
204 }
205
206 devc = fx2lafw_dev_new();
207 devc->profile = prof;
208 sdi->priv = devc;
209 drvc->instances = g_slist_append(drvc->instances, sdi);
210 devices = g_slist_append(devices, sdi);
211
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);
219 } else {
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();
224 else
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]),
229 0xff, NULL);
230 }
231 }
232 libusb_free_device_list(devlist, 1);
233 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
234
235 return devices;
236}
237
238static GSList *dev_list(void)
239{
240 return ((struct drv_context *)(di->priv))->instances;
241}
242
243static int dev_open(struct sr_dev_inst *sdi)
244{
245 struct sr_usb_dev_inst *usb;
246 struct dev_context *devc;
247 int ret;
248 int64_t timediff_us, timediff_ms;
249
250 devc = sdi->priv;
251 usb = sdi->conn;
252
253 /*
254 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
255 * milliseconds for the FX2 to renumerate.
256 */
257 ret = SR_ERR;
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);
262 timediff_ms = 0;
263 while (timediff_ms < MAX_RENUM_DELAY_MS) {
264 if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
265 break;
266 g_usleep(100 * 1000);
267
268 timediff_us = g_get_monotonic_time() - devc->fw_updated;
269 timediff_ms = timediff_us / 1000;
270 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
271 }
272 if (ret != SR_OK) {
273 sr_err("Device failed to renumerate.");
274 return SR_ERR;
275 }
276 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
277 } else {
278 sr_info("Firmware upload was not needed.");
279 ret = fx2lafw_dev_open(sdi, di);
280 }
281
282 if (ret != SR_OK) {
283 sr_err("Unable to open device.");
284 return SR_ERR;
285 }
286
287 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
288 if (ret != 0) {
289 switch (ret) {
290 case LIBUSB_ERROR_BUSY:
291 sr_err("Unable to claim USB interface. Another "
292 "program or driver has already claimed it.");
293 break;
294 case LIBUSB_ERROR_NO_DEVICE:
295 sr_err("Device has been disconnected.");
296 break;
297 default:
298 sr_err("Unable to claim interface: %s.",
299 libusb_error_name(ret));
300 break;
301 }
302
303 return SR_ERR;
304 }
305
306 if (devc->cur_samplerate == 0) {
307 /* Samplerate hasn't been set; default to the slowest one. */
308 devc->cur_samplerate = samplerates[0];
309 }
310
311 return SR_OK;
312}
313
314static int dev_close(struct sr_dev_inst *sdi)
315{
316 struct sr_usb_dev_inst *usb;
317
318 usb = sdi->conn;
319 if (usb->devhdl == NULL)
320 return SR_ERR;
321
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);
326 usb->devhdl = NULL;
327 sdi->status = SR_ST_INACTIVE;
328
329 return SR_OK;
330}
331
332static int cleanup(void)
333{
334 int ret;
335 struct drv_context *drvc;
336
337 if (!(drvc = di->priv))
338 return SR_OK;
339
340
341 ret = std_dev_clear(di, NULL);
342
343 g_free(drvc);
344 di->priv = NULL;
345
346 return ret;
347}
348
349static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
350 const struct sr_channel_group *cg)
351{
352 struct dev_context *devc;
353 struct sr_usb_dev_inst *usb;
354 char str[128];
355
356 (void)cg;
357
358 switch (id) {
359 case SR_CONF_CONN:
360 if (!sdi || !sdi->conn)
361 return SR_ERR_ARG;
362 usb = 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. */
366 return SR_ERR;
367 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
368 *data = g_variant_new_string(str);
369 break;
370 case SR_CONF_SAMPLERATE:
371 if (!sdi)
372 return SR_ERR;
373 devc = sdi->priv;
374 *data = g_variant_new_uint64(devc->cur_samplerate);
375 break;
376 default:
377 return SR_ERR_NA;
378 }
379
380 return SR_OK;
381}
382
383static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
384 const struct sr_channel_group *cg)
385{
386 struct dev_context *devc;
387 int ret;
388
389 (void)cg;
390
391 if (sdi->status != SR_ST_ACTIVE)
392 return SR_ERR;
393
394 devc = sdi->priv;
395
396 if (id == SR_CONF_SAMPLERATE) {
397 devc->cur_samplerate = g_variant_get_uint64(data);
398 ret = SR_OK;
399 } else if (id == SR_CONF_LIMIT_SAMPLES) {
400 devc->limit_samples = g_variant_get_uint64(data);
401 ret = SR_OK;
402 } else {
403 ret = SR_ERR_NA;
404 }
405
406 return ret;
407}
408
409static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
410 const struct sr_channel_group *cg)
411{
412 GVariant *gvar;
413 GVariantBuilder gvb;
414
415 (void)sdi;
416 (void)cg;
417
418 switch (key) {
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));
422 break;
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));
426 break;
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);
433 break;
434 case SR_CONF_TRIGGER_TYPE:
435 *data = g_variant_new_string(TRIGGER_TYPE);
436 break;
437 default:
438 return SR_ERR_NA;
439 }
440
441 return SR_OK;
442}
443
444static int receive_data(int fd, int revents, void *cb_data)
445{
446 struct timeval tv;
447 struct drv_context *drvc;
448
449 (void)fd;
450 (void)revents;
451 (void)cb_data;
452
453 drvc = di->priv;
454
455 tv.tv_sec = tv.tv_usec = 0;
456 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
457
458 return TRUE;
459}
460
461static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
462{
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;
468 int ret;
469 unsigned char *buf;
470 size_t size;
471
472 if (sdi->status != SR_ST_ACTIVE)
473 return SR_ERR_DEV_CLOSED;
474
475 drvc = di->priv;
476 devc = sdi->priv;
477 usb = sdi->conn;
478
479 /* Configures devc->trigger_* and devc->sample_wide */
480 if (fx2lafw_configure_channels(sdi) != SR_OK) {
481 sr_err("Failed to configure channels.");
482 return SR_ERR;
483 }
484
485 devc->cb_data = cb_data;
486 devc->num_samples = 0;
487 devc->empty_transfer_count = 0;
488
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;
493
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;
498 }
499
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;
505 }
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);
514 g_free(buf);
515 fx2lafw_abort_acquisition(devc);
516 return SR_ERR;
517 }
518 devc->transfers[i] = transfer;
519 devc->submitted_transfers++;
520 }
521
522 devc->ctx = drvc->sr_ctx;
523
524 usb_source_add(devc->ctx, timeout, receive_data, NULL);
525
526 /* Send header packet to the session bus. */
527 std_session_send_df_header(cb_data, LOG_PREFIX);
528
529 if ((ret = fx2lafw_command_start_acquisition(usb->devhdl,
530 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
531 fx2lafw_abort_acquisition(devc);
532 return ret;
533 }
534
535 return SR_OK;
536}
537
538static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
539{
540 (void)cb_data;
541
542 fx2lafw_abort_acquisition(sdi->priv);
543
544 return SR_OK;
545}
546
547SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
548 .name = "fx2lafw",
549 .longname = "fx2lafw (generic driver for FX2 based LAs)",
550 .api_version = 1,
551 .init = init,
552 .cleanup = cleanup,
553 .scan = scan,
554 .dev_list = dev_list,
555 .dev_clear = NULL,
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,
563 .priv = NULL,
564};