2 * This file is part of the libsigrok project.
4 * Copyright (C) 2011-2015 Uwe Hermann <uwe@hermann-uwe.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
25 static struct sr_dev_driver *di = &chronovu_la_driver_info;
27 static const uint32_t drvopts[] = {
28 SR_CONF_LOGIC_ANALYZER,
31 static const uint32_t scanopts[] = {
35 static const uint32_t devopts[] = {
36 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
37 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
38 SR_CONF_CONN | SR_CONF_GET,
39 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
40 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
43 static const int32_t trigger_matches[] = {
50 static int dev_acquisition_stop(struct sr_dev_inst *sdi);
52 static void clear_helper(void *priv)
54 struct dev_context *devc;
58 ftdi_free(devc->ftdic);
59 g_free(devc->final_buf);
62 static int dev_clear(const struct sr_dev_driver *di)
64 return std_dev_clear(di, clear_helper);
67 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
69 return std_init(di, sr_ctx, LOG_PREFIX);
72 static int add_device(int model, struct libusb_device_descriptor *des,
73 const char *serial_num, const char *connection_id,
74 libusb_device *usbdev, GSList **devices)
78 struct sr_dev_inst *sdi;
79 struct drv_context *drvc;
80 struct dev_context *devc;
86 /* Allocate memory for our private device context. */
87 devc = g_malloc0(sizeof(struct dev_context));
89 /* Set some sane defaults. */
90 devc->prof = &cv_profiles[model];
91 devc->ftdic = NULL; /* Will be set in the open() API call. */
92 devc->cur_samplerate = 0; /* Set later (different for LA8/LA16). */
94 devc->limit_samples = 0;
95 memset(devc->mangled_buf, 0, BS);
96 devc->final_buf = NULL;
97 devc->trigger_pattern = 0x0000; /* Irrelevant, see trigger_mask. */
98 devc->trigger_mask = 0x0000; /* All channels: "don't care". */
99 devc->trigger_edgemask = 0x0000; /* All channels: "state triggered". */
100 devc->trigger_found = 0;
102 devc->block_counter = 0;
104 devc->usb_vid = des->idVendor;
105 devc->usb_pid = des->idProduct;
106 memset(devc->samplerates, 0, sizeof(uint64_t) * 255);
108 /* Allocate memory where we'll store the de-mangled data. */
109 if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
110 sr_err("Failed to allocate memory for sample buffer.");
115 /* We now know the device, set its max. samplerate as default. */
116 devc->cur_samplerate = devc->prof->max_samplerate;
118 /* Register the device with libsigrok. */
119 sdi = g_malloc0(sizeof(struct sr_dev_inst));
120 sdi->status = SR_ST_INITIALIZING;
121 sdi->vendor = g_strdup("ChronoVu");
122 sdi->model = g_strdup(devc->prof->modelname);
123 sdi->serial_num = g_strdup(serial_num);
124 sdi->connection_id = g_strdup(connection_id);
125 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(usbdev),
126 libusb_get_device_address(usbdev), NULL);
130 for (i = 0; i < devc->prof->num_channels; i++)
131 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
132 cv_channel_names[i]);
134 *devices = g_slist_append(*devices, sdi);
135 drvc->instances = g_slist_append(drvc->instances, sdi);
146 static GSList *scan(struct sr_dev_driver *di, GSList *options)
149 struct drv_context *drvc;
150 GSList *devices, *conn_devices, *l;
151 struct sr_usb_dev_inst *usb;
152 struct sr_config *src;
153 struct libusb_device_descriptor des;
154 libusb_device **devlist;
155 struct libusb_device_handle *hdl;
157 char product[64], serial_num[64], connection_id[64];
160 drvc->instances = NULL;
163 for (l = options; l; l = l->next) {
167 conn = g_variant_get_string(src->data, NULL);
172 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
177 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
179 for (i = 0; devlist[i]; i++) {
181 for (l = conn_devices; l; l = l->next) {
183 if (usb->bus == libusb_get_bus_number(devlist[i])
184 && usb->address == libusb_get_device_address(devlist[i]))
188 /* This device matched none of the ones that
189 * matched the conn specification. */
193 libusb_get_device_descriptor(devlist[i], &des);
195 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
198 if (des.iProduct == 0) {
200 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
201 des.iProduct, (unsigned char *)product,
202 sizeof(product))) < 0) {
203 sr_warn("Failed to get product string descriptor: %s.",
204 libusb_error_name(ret));
208 if (des.iSerialNumber == 0) {
209 serial_num[0] = '\0';
210 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
211 des.iSerialNumber, (unsigned char *)serial_num,
212 sizeof(serial_num))) < 0) {
213 sr_warn("Failed to get serial number string descriptor: %s.",
214 libusb_error_name(ret));
218 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
222 if (!strcmp(product, "ChronoVu LA8")) {
224 } else if (!strcmp(product, "ChronoVu LA16")) {
227 sr_spew("Unknown iProduct string '%s'.", product);
231 sr_dbg("Found %s (%04x:%04x, %d.%d, %s).",
232 product, des.idVendor, des.idProduct,
233 libusb_get_bus_number(devlist[i]),
234 libusb_get_device_address(devlist[i]), connection_id);
236 if ((ret = add_device(model, &des, serial_num, connection_id,
237 devlist[i], &devices)) < 0) {
238 sr_dbg("Failed to add device: %d.", ret);
242 libusb_free_device_list(devlist, 1);
243 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
248 static int dev_open(struct sr_dev_inst *sdi)
250 struct dev_context *devc;
255 /* Allocate memory for the FTDI context and initialize it. */
256 if (!(devc->ftdic = ftdi_new())) {
257 sr_err("Failed to initialize libftdi.");
261 sr_dbg("Opening %s device (%04x:%04x).", devc->prof->modelname,
262 devc->usb_vid, devc->usb_pid);
264 /* Open the device. */
265 if ((ret = ftdi_usb_open_desc(devc->ftdic, devc->usb_vid,
266 devc->usb_pid, devc->prof->iproduct, NULL)) < 0) {
267 sr_err("Failed to open FTDI device (%d): %s.",
268 ret, ftdi_get_error_string(devc->ftdic));
271 sr_dbg("Device opened successfully.");
273 /* Purge RX/TX buffers in the FTDI chip. */
274 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
275 sr_err("Failed to purge FTDI buffers (%d): %s.",
276 ret, ftdi_get_error_string(devc->ftdic));
279 sr_dbg("FTDI buffers purged successfully.");
281 /* Enable flow control in the FTDI chip. */
282 if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
283 sr_err("Failed to enable FTDI flow control (%d): %s.",
284 ret, ftdi_get_error_string(devc->ftdic));
287 sr_dbg("FTDI flow control enabled successfully.");
290 g_usleep(100 * 1000);
292 sdi->status = SR_ST_ACTIVE;
298 ftdi_free(devc->ftdic); /* Close device (if open), free FTDI context. */
303 static int dev_close(struct sr_dev_inst *sdi)
306 struct dev_context *devc;
308 if (sdi->status != SR_ST_ACTIVE)
313 if (devc->ftdic && (ret = ftdi_usb_close(devc->ftdic)) < 0)
314 sr_err("Failed to close FTDI device (%d): %s.",
315 ret, ftdi_get_error_string(devc->ftdic));
316 sdi->status = SR_ST_INACTIVE;
321 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
322 const struct sr_channel_group *cg)
324 struct dev_context *devc;
325 struct sr_usb_dev_inst *usb;
332 if (!sdi || !(usb = sdi->conn))
334 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
335 *data = g_variant_new_string(str);
337 case SR_CONF_SAMPLERATE:
338 if (!sdi || !(devc = sdi->priv))
340 *data = g_variant_new_uint64(devc->cur_samplerate);
349 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
350 const struct sr_channel_group *cg)
352 struct dev_context *devc;
356 if (sdi->status != SR_ST_ACTIVE)
357 return SR_ERR_DEV_CLOSED;
359 if (!(devc = sdi->priv))
363 case SR_CONF_SAMPLERATE:
364 if (cv_set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
367 case SR_CONF_LIMIT_MSEC:
368 if (g_variant_get_uint64(data) == 0)
370 devc->limit_msec = g_variant_get_uint64(data);
372 case SR_CONF_LIMIT_SAMPLES:
373 if (g_variant_get_uint64(data) == 0)
375 devc->limit_samples = g_variant_get_uint64(data);
384 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
385 const struct sr_channel_group *cg)
387 GVariant *gvar, *grange[2];
389 struct dev_context *devc;
394 case SR_CONF_SCAN_OPTIONS:
395 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
396 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
398 case SR_CONF_DEVICE_OPTIONS:
400 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
401 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
403 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
404 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
406 case SR_CONF_SAMPLERATE:
407 if (!sdi || !sdi->priv || !(devc = sdi->priv))
409 cv_fill_samplerates_if_needed(sdi);
410 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
411 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
413 ARRAY_SIZE(devc->samplerates),
415 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
416 *data = g_variant_builder_end(&gvb);
418 case SR_CONF_LIMIT_SAMPLES:
419 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
421 grange[0] = g_variant_new_uint64(0);
422 if (devc->prof->model == CHRONOVU_LA8)
423 grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES);
425 grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES / 2);
426 *data = g_variant_new_tuple(grange, 2);
428 case SR_CONF_TRIGGER_MATCH:
429 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
431 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
432 trigger_matches, devc->prof->num_trigger_matches,
442 static int receive_data(int fd, int revents, void *cb_data)
445 struct sr_dev_inst *sdi;
446 struct dev_context *devc;
451 if (!(sdi = cb_data)) {
452 sr_err("cb_data was NULL.");
456 if (!(devc = sdi->priv)) {
457 sr_err("sdi->priv was NULL.");
462 sr_err("devc->ftdic was NULL.");
466 /* Get one block of data. */
467 if ((ret = cv_read_block(devc)) < 0) {
468 sr_err("Failed to read data block: %d.", ret);
469 dev_acquisition_stop(sdi);
473 /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
474 if (devc->block_counter != (NUM_BLOCKS - 1)) {
475 devc->block_counter++;
479 sr_dbg("Sampling finished, sending data to session bus now.");
482 * All data was received and demangled, send it to the session bus.
484 * Note: Due to the method how data is spread across the 8MByte of
485 * SDRAM, we can _not_ send it to the session bus in a streaming
486 * manner while we receive it. We have to receive and de-mangle the
487 * full 8MByte first, only then the whole buffer contains valid data.
489 for (i = 0; i < NUM_BLOCKS; i++)
490 cv_send_block_to_session_bus(sdi, i);
492 dev_acquisition_stop(sdi);
497 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
499 struct dev_context *devc;
501 int bytes_to_write, bytes_written;
503 if (sdi->status != SR_ST_ACTIVE)
504 return SR_ERR_DEV_CLOSED;
509 sr_err("devc->ftdic was NULL.");
513 devc->divcount = cv_samplerate_to_divcount(sdi, devc->cur_samplerate);
514 if (devc->divcount == 0xff) {
515 sr_err("Invalid divcount/samplerate.");
519 if (cv_convert_trigger(sdi) != SR_OK) {
520 sr_err("Failed to configure trigger.");
524 /* Fill acquisition parameters into buf[]. */
525 if (devc->prof->model == CHRONOVU_LA8) {
526 buf[0] = devc->divcount;
527 buf[1] = 0xff; /* This byte must always be 0xff. */
528 buf[2] = devc->trigger_pattern & 0xff;
529 buf[3] = devc->trigger_mask & 0xff;
532 buf[0] = devc->divcount;
533 buf[1] = 0xff; /* This byte must always be 0xff. */
534 buf[2] = (devc->trigger_pattern & 0xff00) >> 8; /* LSB */
535 buf[3] = (devc->trigger_pattern & 0x00ff) >> 0; /* MSB */
536 buf[4] = (devc->trigger_mask & 0xff00) >> 8; /* LSB */
537 buf[5] = (devc->trigger_mask & 0x00ff) >> 0; /* MSB */
538 buf[6] = (devc->trigger_edgemask & 0xff00) >> 8; /* LSB */
539 buf[7] = (devc->trigger_edgemask & 0x00ff) >> 0; /* MSB */
543 /* Start acquisition. */
544 bytes_written = cv_write(devc, buf, bytes_to_write);
546 if (bytes_written < 0 || bytes_written != bytes_to_write) {
547 sr_err("Acquisition failed to start.");
551 sr_dbg("Hardware acquisition started successfully.");
553 std_session_send_df_header(sdi, LOG_PREFIX);
555 /* Time when we should be done (for detecting trigger timeouts). */
556 devc->done = (devc->divcount + 1) * devc->prof->trigger_constant +
557 g_get_monotonic_time() + (10 * G_TIME_SPAN_SECOND);
558 devc->block_counter = 0;
559 devc->trigger_found = 0;
561 /* Hook up a dummy handler to receive data from the device. */
562 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
567 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
569 sr_dbg("Stopping acquisition.");
570 sr_session_source_remove(sdi->session, -1);
571 std_session_send_df_end(sdi, LOG_PREFIX);
576 SR_PRIV struct sr_dev_driver chronovu_la_driver_info = {
577 .name = "chronovu-la",
578 .longname = "ChronoVu LA8/LA16",
581 .cleanup = std_cleanup,
583 .dev_list = std_dev_list,
584 .dev_clear = dev_clear,
585 .config_get = config_get,
586 .config_set = config_set,
587 .config_list = config_list,
588 .dev_open = dev_open,
589 .dev_close = dev_close,
590 .dev_acquisition_start = dev_acquisition_start,
591 .dev_acquisition_stop = dev_acquisition_stop,