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, see <http://www.gnu.org/licenses/>.
23 static const uint32_t scanopts[] = {
27 static const uint32_t drvopts[] = {
28 SR_CONF_LOGIC_ANALYZER,
31 static const uint32_t devopts[] = {
32 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
33 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
34 SR_CONF_CONN | SR_CONF_GET,
35 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
39 static const int32_t trigger_matches[] = {
46 static void clear_helper(struct dev_context *devc)
48 ftdi_free(devc->ftdic);
49 g_free(devc->final_buf);
52 static int dev_clear(const struct sr_dev_driver *di)
54 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
57 static int add_device(int model, struct libusb_device_descriptor *des,
58 const char *serial_num, const char *connection_id, libusb_device *usbdev,
63 struct sr_dev_inst *sdi;
64 struct dev_context *devc;
68 devc = g_malloc0(sizeof(struct dev_context));
70 /* Set some sane defaults. */
71 devc->prof = &cv_profiles[model];
72 devc->ftdic = NULL; /* Will be set in the open() API call. */
73 devc->cur_samplerate = 0; /* Set later (different for LA8/LA16). */
75 devc->limit_samples = 0;
76 memset(devc->mangled_buf, 0, BS);
77 devc->final_buf = NULL;
78 devc->trigger_pattern = 0x0000; /* Irrelevant, see trigger_mask. */
79 devc->trigger_mask = 0x0000; /* All channels: "don't care". */
80 devc->trigger_edgemask = 0x0000; /* All channels: "state triggered". */
81 devc->trigger_found = 0;
83 devc->block_counter = 0;
85 devc->usb_vid = des->idVendor;
86 devc->usb_pid = des->idProduct;
87 memset(devc->samplerates, 0, sizeof(uint64_t) * 255);
89 /* Allocate memory where we'll store the de-mangled data. */
90 if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
91 sr_err("Failed to allocate memory for sample buffer.");
96 /* We now know the device, set its max. samplerate as default. */
97 devc->cur_samplerate = devc->prof->max_samplerate;
99 sdi = g_malloc0(sizeof(struct sr_dev_inst));
100 sdi->status = SR_ST_INACTIVE;
101 sdi->vendor = g_strdup("ChronoVu");
102 sdi->model = g_strdup(devc->prof->modelname);
103 sdi->serial_num = g_strdup(serial_num);
104 sdi->connection_id = g_strdup(connection_id);
105 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(usbdev),
106 libusb_get_device_address(usbdev), NULL);
109 for (i = 0; i < devc->prof->num_channels; i++)
110 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
111 cv_channel_names[i]);
113 *devices = g_slist_append(*devices, sdi);
124 static GSList *scan(struct sr_dev_driver *di, GSList *options)
127 struct drv_context *drvc;
128 GSList *devices, *conn_devices, *l;
129 struct sr_usb_dev_inst *usb;
130 struct sr_config *src;
131 struct libusb_device_descriptor des;
132 libusb_device **devlist;
133 struct libusb_device_handle *hdl;
135 char product[64], serial_num[64], connection_id[64];
140 for (l = options; l; l = l->next) {
144 conn = g_variant_get_string(src->data, NULL);
149 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
154 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
156 for (i = 0; devlist[i]; i++) {
158 for (l = conn_devices; l; l = l->next) {
160 if (usb->bus == libusb_get_bus_number(devlist[i])
161 && usb->address == libusb_get_device_address(devlist[i]))
165 /* This device matched none of the ones that
166 * matched the conn specification. */
170 libusb_get_device_descriptor(devlist[i], &des);
172 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
175 if (des.iProduct == 0) {
177 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
178 des.iProduct, (unsigned char *)product,
179 sizeof(product))) < 0) {
180 sr_warn("Failed to get product string descriptor: %s.",
181 libusb_error_name(ret));
185 if (des.iSerialNumber == 0) {
186 serial_num[0] = '\0';
187 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
188 des.iSerialNumber, (unsigned char *)serial_num,
189 sizeof(serial_num))) < 0) {
190 sr_warn("Failed to get serial number string descriptor: %s.",
191 libusb_error_name(ret));
195 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
199 if (!strcmp(product, "ChronoVu LA8")) {
201 } else if (!strcmp(product, "ChronoVu LA16")) {
204 sr_spew("Unknown iProduct string '%s'.", product);
208 sr_dbg("Found %s (%04x:%04x, %d.%d, %s).",
209 product, des.idVendor, des.idProduct,
210 libusb_get_bus_number(devlist[i]),
211 libusb_get_device_address(devlist[i]), connection_id);
213 if ((ret = add_device(model, &des, serial_num, connection_id,
214 devlist[i], &devices)) < 0) {
215 sr_dbg("Failed to add device: %d.", ret);
219 libusb_free_device_list(devlist, 1);
220 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
222 return std_scan_complete(di, devices);
225 static int dev_open(struct sr_dev_inst *sdi)
227 struct dev_context *devc;
232 if (!(devc->ftdic = ftdi_new())) {
233 sr_err("Failed to initialize libftdi.");
237 sr_dbg("Opening %s device (%04x:%04x).", devc->prof->modelname,
238 devc->usb_vid, devc->usb_pid);
240 if ((ret = ftdi_usb_open_desc(devc->ftdic, devc->usb_vid,
241 devc->usb_pid, devc->prof->iproduct, NULL)) < 0) {
242 sr_err("Failed to open FTDI device (%d): %s.",
243 ret, ftdi_get_error_string(devc->ftdic));
247 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
248 sr_err("Failed to purge FTDI buffers (%d): %s.",
249 ret, ftdi_get_error_string(devc->ftdic));
253 if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
254 sr_err("Failed to enable FTDI flow control (%d): %s.",
255 ret, ftdi_get_error_string(devc->ftdic));
259 g_usleep(100 * 1000);
264 ftdi_free(devc->ftdic); /* Close device (if open), free FTDI context. */
269 static int dev_close(struct sr_dev_inst *sdi)
272 struct dev_context *devc;
279 if ((ret = ftdi_usb_close(devc->ftdic)) < 0)
280 sr_err("Failed to close FTDI device (%d): %s.",
281 ret, ftdi_get_error_string(devc->ftdic));
283 return (ret == 0) ? SR_OK : SR_ERR;
286 static int config_get(uint32_t key, GVariant **data,
287 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
289 struct dev_context *devc;
290 struct sr_usb_dev_inst *usb;
296 if (!sdi || !(usb = sdi->conn))
298 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
300 case SR_CONF_SAMPLERATE:
304 *data = g_variant_new_uint64(devc->cur_samplerate);
313 static int config_set(uint32_t key, GVariant *data,
314 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
316 struct dev_context *devc;
323 case SR_CONF_SAMPLERATE:
324 if (cv_set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
327 case SR_CONF_LIMIT_MSEC:
328 devc->limit_msec = g_variant_get_uint64(data);
330 case SR_CONF_LIMIT_SAMPLES:
331 devc->limit_samples = g_variant_get_uint64(data);
340 static int config_list(uint32_t key, GVariant **data,
341 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
343 struct dev_context *devc;
345 devc = (sdi) ? sdi->priv : NULL;
348 case SR_CONF_SCAN_OPTIONS:
349 case SR_CONF_DEVICE_OPTIONS:
350 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
351 case SR_CONF_SAMPLERATE:
352 cv_fill_samplerates_if_needed(sdi);
353 *data = std_gvar_samplerates(ARRAY_AND_SIZE(devc->samplerates));
355 case SR_CONF_LIMIT_SAMPLES:
358 *data = std_gvar_tuple_u64(0, (devc->prof->model == CHRONOVU_LA8) ? MAX_NUM_SAMPLES : MAX_NUM_SAMPLES / 2);
360 case SR_CONF_TRIGGER_MATCH:
363 *data = std_gvar_array_i32(trigger_matches, devc->prof->num_trigger_matches);
372 static int receive_data(int fd, int revents, void *cb_data)
375 struct sr_dev_inst *sdi;
376 struct dev_context *devc;
381 if (!(sdi = cb_data)) {
382 sr_err("cb_data was NULL.");
386 if (!(devc = sdi->priv)) {
387 sr_err("sdi->priv was NULL.");
392 sr_err("devc->ftdic was NULL.");
396 /* Get one block of data. */
397 if ((ret = cv_read_block(devc)) < 0) {
398 sr_err("Failed to read data block: %d.", ret);
399 sr_dev_acquisition_stop(sdi);
403 /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
404 if (devc->block_counter != (NUM_BLOCKS - 1)) {
405 devc->block_counter++;
409 sr_dbg("Sampling finished, sending data to session bus now.");
412 * All data was received and demangled, send it to the session bus.
414 * Note: Due to the method how data is spread across the 8MByte of
415 * SDRAM, we can _not_ send it to the session bus in a streaming
416 * manner while we receive it. We have to receive and de-mangle the
417 * full 8MByte first, only then the whole buffer contains valid data.
419 for (i = 0; i < NUM_BLOCKS; i++)
420 cv_send_block_to_session_bus(sdi, i);
422 sr_dev_acquisition_stop(sdi);
427 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
429 struct dev_context *devc;
431 int bytes_to_write, bytes_written;
436 sr_err("devc->ftdic was NULL.");
440 devc->divcount = cv_samplerate_to_divcount(sdi, devc->cur_samplerate);
441 if (devc->divcount == 0xff) {
442 sr_err("Invalid divcount/samplerate.");
446 if (cv_convert_trigger(sdi) != SR_OK) {
447 sr_err("Failed to configure trigger.");
451 /* Fill acquisition parameters into buf[]. */
452 if (devc->prof->model == CHRONOVU_LA8) {
453 buf[0] = devc->divcount;
454 buf[1] = 0xff; /* This byte must always be 0xff. */
455 buf[2] = devc->trigger_pattern & 0xff;
456 buf[3] = devc->trigger_mask & 0xff;
459 buf[0] = devc->divcount;
460 buf[1] = 0xff; /* This byte must always be 0xff. */
461 buf[2] = (devc->trigger_pattern & 0xff00) >> 8; /* LSB */
462 buf[3] = (devc->trigger_pattern & 0x00ff) >> 0; /* MSB */
463 buf[4] = (devc->trigger_mask & 0xff00) >> 8; /* LSB */
464 buf[5] = (devc->trigger_mask & 0x00ff) >> 0; /* MSB */
465 buf[6] = (devc->trigger_edgemask & 0xff00) >> 8; /* LSB */
466 buf[7] = (devc->trigger_edgemask & 0x00ff) >> 0; /* MSB */
470 /* Start acquisition. */
471 bytes_written = cv_write(devc, buf, bytes_to_write);
473 if (bytes_written < 0 || bytes_written != bytes_to_write) {
474 sr_err("Acquisition failed to start.");
478 std_session_send_df_header(sdi);
480 /* Time when we should be done (for detecting trigger timeouts). */
481 devc->done = (devc->divcount + 1) * devc->prof->trigger_constant +
482 g_get_monotonic_time() + (10 * G_TIME_SPAN_SECOND);
483 devc->block_counter = 0;
484 devc->trigger_found = 0;
486 /* Hook up a dummy handler to receive data from the device. */
487 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
492 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
494 sr_session_source_remove(sdi->session, -1);
495 std_session_send_df_end(sdi);
500 static struct sr_dev_driver chronovu_la_driver_info = {
501 .name = "chronovu-la",
502 .longname = "ChronoVu LA8/LA16",
505 .cleanup = std_cleanup,
507 .dev_list = std_dev_list,
508 .dev_clear = dev_clear,
509 .config_get = config_get,
510 .config_set = config_set,
511 .config_list = config_list,
512 .dev_open = dev_open,
513 .dev_close = dev_close,
514 .dev_acquisition_start = dev_acquisition_start,
515 .dev_acquisition_stop = dev_acquisition_stop,
518 SR_REGISTER_DEV_DRIVER(chronovu_la_driver_info);