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 add_device(int model, struct libusb_device_descriptor *des,
68 const char *serial_num, const char *connection_id,
69 libusb_device *usbdev, GSList **devices)
73 struct sr_dev_inst *sdi;
74 struct drv_context *drvc;
75 struct dev_context *devc;
81 /* Allocate memory for our private device context. */
82 devc = g_malloc0(sizeof(struct dev_context));
84 /* Set some sane defaults. */
85 devc->prof = &cv_profiles[model];
86 devc->ftdic = NULL; /* Will be set in the open() API call. */
87 devc->cur_samplerate = 0; /* Set later (different for LA8/LA16). */
89 devc->limit_samples = 0;
90 memset(devc->mangled_buf, 0, BS);
91 devc->final_buf = NULL;
92 devc->trigger_pattern = 0x0000; /* Irrelevant, see trigger_mask. */
93 devc->trigger_mask = 0x0000; /* All channels: "don't care". */
94 devc->trigger_edgemask = 0x0000; /* All channels: "state triggered". */
95 devc->trigger_found = 0;
97 devc->block_counter = 0;
99 devc->usb_vid = des->idVendor;
100 devc->usb_pid = des->idProduct;
101 memset(devc->samplerates, 0, sizeof(uint64_t) * 255);
103 /* Allocate memory where we'll store the de-mangled data. */
104 if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
105 sr_err("Failed to allocate memory for sample buffer.");
110 /* We now know the device, set its max. samplerate as default. */
111 devc->cur_samplerate = devc->prof->max_samplerate;
113 /* Register the device with libsigrok. */
114 sdi = g_malloc0(sizeof(struct sr_dev_inst));
115 sdi->status = SR_ST_INACTIVE;
116 sdi->vendor = g_strdup("ChronoVu");
117 sdi->model = g_strdup(devc->prof->modelname);
118 sdi->serial_num = g_strdup(serial_num);
119 sdi->connection_id = g_strdup(connection_id);
120 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(usbdev),
121 libusb_get_device_address(usbdev), NULL);
125 for (i = 0; i < devc->prof->num_channels; i++)
126 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
127 cv_channel_names[i]);
129 *devices = g_slist_append(*devices, sdi);
130 drvc->instances = g_slist_append(drvc->instances, sdi);
141 static GSList *scan(struct sr_dev_driver *di, GSList *options)
144 struct drv_context *drvc;
145 GSList *devices, *conn_devices, *l;
146 struct sr_usb_dev_inst *usb;
147 struct sr_config *src;
148 struct libusb_device_descriptor des;
149 libusb_device **devlist;
150 struct libusb_device_handle *hdl;
152 char product[64], serial_num[64], connection_id[64];
155 drvc->instances = NULL;
158 for (l = options; l; l = l->next) {
162 conn = g_variant_get_string(src->data, NULL);
167 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
172 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
174 for (i = 0; devlist[i]; i++) {
176 for (l = conn_devices; l; l = l->next) {
178 if (usb->bus == libusb_get_bus_number(devlist[i])
179 && usb->address == libusb_get_device_address(devlist[i]))
183 /* This device matched none of the ones that
184 * matched the conn specification. */
188 libusb_get_device_descriptor(devlist[i], &des);
190 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
193 if (des.iProduct == 0) {
195 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
196 des.iProduct, (unsigned char *)product,
197 sizeof(product))) < 0) {
198 sr_warn("Failed to get product string descriptor: %s.",
199 libusb_error_name(ret));
203 if (des.iSerialNumber == 0) {
204 serial_num[0] = '\0';
205 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
206 des.iSerialNumber, (unsigned char *)serial_num,
207 sizeof(serial_num))) < 0) {
208 sr_warn("Failed to get serial number string descriptor: %s.",
209 libusb_error_name(ret));
213 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
217 if (!strcmp(product, "ChronoVu LA8")) {
219 } else if (!strcmp(product, "ChronoVu LA16")) {
222 sr_spew("Unknown iProduct string '%s'.", product);
226 sr_dbg("Found %s (%04x:%04x, %d.%d, %s).",
227 product, des.idVendor, des.idProduct,
228 libusb_get_bus_number(devlist[i]),
229 libusb_get_device_address(devlist[i]), connection_id);
231 if ((ret = add_device(model, &des, serial_num, connection_id,
232 devlist[i], &devices)) < 0) {
233 sr_dbg("Failed to add device: %d.", ret);
237 libusb_free_device_list(devlist, 1);
238 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
243 static int dev_open(struct sr_dev_inst *sdi)
245 struct dev_context *devc;
250 /* Allocate memory for the FTDI context and initialize it. */
251 if (!(devc->ftdic = ftdi_new())) {
252 sr_err("Failed to initialize libftdi.");
256 sr_dbg("Opening %s device (%04x:%04x).", devc->prof->modelname,
257 devc->usb_vid, devc->usb_pid);
259 /* Open the device. */
260 if ((ret = ftdi_usb_open_desc(devc->ftdic, devc->usb_vid,
261 devc->usb_pid, devc->prof->iproduct, NULL)) < 0) {
262 sr_err("Failed to open FTDI device (%d): %s.",
263 ret, ftdi_get_error_string(devc->ftdic));
266 sr_dbg("Device opened successfully.");
268 /* Purge RX/TX buffers in the FTDI chip. */
269 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
270 sr_err("Failed to purge FTDI buffers (%d): %s.",
271 ret, ftdi_get_error_string(devc->ftdic));
274 sr_dbg("FTDI buffers purged successfully.");
276 /* Enable flow control in the FTDI chip. */
277 if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
278 sr_err("Failed to enable FTDI flow control (%d): %s.",
279 ret, ftdi_get_error_string(devc->ftdic));
282 sr_dbg("FTDI flow control enabled successfully.");
285 g_usleep(100 * 1000);
287 sdi->status = SR_ST_ACTIVE;
293 ftdi_free(devc->ftdic); /* Close device (if open), free FTDI context. */
298 static int dev_close(struct sr_dev_inst *sdi)
301 struct dev_context *devc;
303 if (sdi->status != SR_ST_ACTIVE)
308 if (devc->ftdic && (ret = ftdi_usb_close(devc->ftdic)) < 0)
309 sr_err("Failed to close FTDI device (%d): %s.",
310 ret, ftdi_get_error_string(devc->ftdic));
311 sdi->status = SR_ST_INACTIVE;
316 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
317 const struct sr_channel_group *cg)
319 struct dev_context *devc;
320 struct sr_usb_dev_inst *usb;
327 if (!sdi || !(usb = sdi->conn))
329 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
330 *data = g_variant_new_string(str);
332 case SR_CONF_SAMPLERATE:
336 *data = g_variant_new_uint64(devc->cur_samplerate);
345 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
346 const struct sr_channel_group *cg)
348 struct dev_context *devc;
352 if (sdi->status != SR_ST_ACTIVE)
353 return SR_ERR_DEV_CLOSED;
358 case SR_CONF_SAMPLERATE:
359 if (cv_set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
362 case SR_CONF_LIMIT_MSEC:
363 if (g_variant_get_uint64(data) == 0)
365 devc->limit_msec = g_variant_get_uint64(data);
367 case SR_CONF_LIMIT_SAMPLES:
368 if (g_variant_get_uint64(data) == 0)
370 devc->limit_samples = g_variant_get_uint64(data);
379 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
380 const struct sr_channel_group *cg)
382 GVariant *gvar, *grange[2];
384 struct dev_context *devc;
389 case SR_CONF_SCAN_OPTIONS:
390 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
391 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
393 case SR_CONF_DEVICE_OPTIONS:
395 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
396 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
398 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
399 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
401 case SR_CONF_SAMPLERATE:
405 cv_fill_samplerates_if_needed(sdi);
406 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
407 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
409 ARRAY_SIZE(devc->samplerates),
411 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
412 *data = g_variant_builder_end(&gvb);
414 case SR_CONF_LIMIT_SAMPLES:
415 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
417 grange[0] = g_variant_new_uint64(0);
418 if (devc->prof->model == CHRONOVU_LA8)
419 grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES);
421 grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES / 2);
422 *data = g_variant_new_tuple(grange, 2);
424 case SR_CONF_TRIGGER_MATCH:
425 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
427 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
428 trigger_matches, devc->prof->num_trigger_matches,
438 static int receive_data(int fd, int revents, void *cb_data)
441 struct sr_dev_inst *sdi;
442 struct dev_context *devc;
447 if (!(sdi = cb_data)) {
448 sr_err("cb_data was NULL.");
452 if (!(devc = sdi->priv)) {
453 sr_err("sdi->priv was NULL.");
458 sr_err("devc->ftdic was NULL.");
462 /* Get one block of data. */
463 if ((ret = cv_read_block(devc)) < 0) {
464 sr_err("Failed to read data block: %d.", ret);
465 dev_acquisition_stop(sdi);
469 /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
470 if (devc->block_counter != (NUM_BLOCKS - 1)) {
471 devc->block_counter++;
475 sr_dbg("Sampling finished, sending data to session bus now.");
478 * All data was received and demangled, send it to the session bus.
480 * Note: Due to the method how data is spread across the 8MByte of
481 * SDRAM, we can _not_ send it to the session bus in a streaming
482 * manner while we receive it. We have to receive and de-mangle the
483 * full 8MByte first, only then the whole buffer contains valid data.
485 for (i = 0; i < NUM_BLOCKS; i++)
486 cv_send_block_to_session_bus(sdi, i);
488 dev_acquisition_stop(sdi);
493 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
495 struct dev_context *devc;
497 int bytes_to_write, bytes_written;
499 if (sdi->status != SR_ST_ACTIVE)
500 return SR_ERR_DEV_CLOSED;
505 sr_err("devc->ftdic was NULL.");
509 devc->divcount = cv_samplerate_to_divcount(sdi, devc->cur_samplerate);
510 if (devc->divcount == 0xff) {
511 sr_err("Invalid divcount/samplerate.");
515 if (cv_convert_trigger(sdi) != SR_OK) {
516 sr_err("Failed to configure trigger.");
520 /* Fill acquisition parameters into buf[]. */
521 if (devc->prof->model == CHRONOVU_LA8) {
522 buf[0] = devc->divcount;
523 buf[1] = 0xff; /* This byte must always be 0xff. */
524 buf[2] = devc->trigger_pattern & 0xff;
525 buf[3] = devc->trigger_mask & 0xff;
528 buf[0] = devc->divcount;
529 buf[1] = 0xff; /* This byte must always be 0xff. */
530 buf[2] = (devc->trigger_pattern & 0xff00) >> 8; /* LSB */
531 buf[3] = (devc->trigger_pattern & 0x00ff) >> 0; /* MSB */
532 buf[4] = (devc->trigger_mask & 0xff00) >> 8; /* LSB */
533 buf[5] = (devc->trigger_mask & 0x00ff) >> 0; /* MSB */
534 buf[6] = (devc->trigger_edgemask & 0xff00) >> 8; /* LSB */
535 buf[7] = (devc->trigger_edgemask & 0x00ff) >> 0; /* MSB */
539 /* Start acquisition. */
540 bytes_written = cv_write(devc, buf, bytes_to_write);
542 if (bytes_written < 0 || bytes_written != bytes_to_write) {
543 sr_err("Acquisition failed to start.");
547 sr_dbg("Hardware acquisition started successfully.");
549 std_session_send_df_header(sdi, LOG_PREFIX);
551 /* Time when we should be done (for detecting trigger timeouts). */
552 devc->done = (devc->divcount + 1) * devc->prof->trigger_constant +
553 g_get_monotonic_time() + (10 * G_TIME_SPAN_SECOND);
554 devc->block_counter = 0;
555 devc->trigger_found = 0;
557 /* Hook up a dummy handler to receive data from the device. */
558 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
563 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
565 sr_dbg("Stopping acquisition.");
566 sr_session_source_remove(sdi->session, -1);
567 std_session_send_df_end(sdi, LOG_PREFIX);
572 SR_PRIV struct sr_dev_driver chronovu_la_driver_info = {
573 .name = "chronovu-la",
574 .longname = "ChronoVu LA8/LA16",
577 .cleanup = std_cleanup,
579 .dev_list = std_dev_list,
580 .dev_clear = dev_clear,
581 .config_get = config_get,
582 .config_set = config_set,
583 .config_list = config_list,
584 .dev_open = dev_open,
585 .dev_close = dev_close,
586 .dev_acquisition_start = dev_acquisition_start,
587 .dev_acquisition_stop = dev_acquisition_stop,