2 * This file is part of the libsigrok project.
4 * Copyright (C) 2011-2014 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
23 SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
24 static struct sr_dev_driver *di = &chronovu_la_driver_info;
26 static const int32_t hwcaps[] = {
27 SR_CONF_LOGIC_ANALYZER,
29 SR_CONF_LIMIT_MSEC, /* TODO: Not yet implemented. */
30 SR_CONF_LIMIT_SAMPLES, /* TODO: Not yet implemented. */
33 /* The ChronoVu LA8/LA16 can have multiple VID/PID pairs. */
40 { 0x0403, 0x6001, CHRONOVU_LA8, "ChronoVu LA8" },
41 { 0x0403, 0x8867, CHRONOVU_LA8, "ChronoVu LA8" },
42 { 0x0403, 0x6001, CHRONOVU_LA16, "ChronoVu LA16" },
43 { 0x0403, 0x8867, CHRONOVU_LA16, "ChronoVu LA16" },
46 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
48 static void clear_helper(void *priv)
50 struct dev_context *devc;
54 ftdi_free(devc->ftdic);
55 g_free(devc->final_buf);
58 static int dev_clear(void)
60 return std_dev_clear(di, clear_helper);
63 static int init(struct sr_context *sr_ctx)
65 return std_init(sr_ctx, di, LOG_PREFIX);
68 static int add_device(int idx, int model, GSList **devices)
72 struct sr_dev_inst *sdi;
73 struct drv_context *drvc;
74 struct dev_context *devc;
75 struct sr_channel *ch;
81 /* Allocate memory for our private device context. */
82 devc = g_try_malloc(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;
91 memset(devc->mangled_buf, 0, BS);
92 devc->final_buf = NULL;
93 devc->trigger_pattern = 0x0000; /* Irrelevant, see trigger_mask. */
94 devc->trigger_mask = 0x0000; /* All channels: "don't care". */
95 devc->trigger_edgemask = 0x0000; /* All channels: "state triggered". */
96 devc->trigger_found = 0;
98 devc->block_counter = 0;
100 devc->usb_vid = vid_pid[idx].vid;
101 devc->usb_pid = vid_pid[idx].pid;
102 memset(devc->samplerates, 0, sizeof(uint64_t) * 255);
104 /* Allocate memory where we'll store the de-mangled data. */
105 if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
106 sr_err("Failed to allocate memory for sample buffer.");
111 /* We now know the device, set its max. samplerate as default. */
112 devc->cur_samplerate = devc->prof->max_samplerate;
114 /* Register the device with libsigrok. */
115 sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
116 "ChronoVu", devc->prof->modelname, NULL);
118 sr_err("Failed to create device instance.");
120 goto err_free_final_buf;
125 for (i = 0; i < devc->prof->num_channels; i++) {
126 if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
127 cv_channel_names[i]))) {
129 goto err_free_dev_inst;
131 sdi->channels = g_slist_append(sdi->channels, ch);
134 *devices = g_slist_append(*devices, sdi);
135 drvc->instances = g_slist_append(drvc->instances, sdi);
140 sr_dev_inst_free(sdi);
142 g_free(devc->final_buf);
149 static GSList *scan(GSList *options)
154 struct ftdi_context *ftdic;
160 /* Allocate memory for the FTDI context and initialize it. */
161 if (!(ftdic = ftdi_new())) {
162 sr_err("Failed to initialize libftdi.");
166 /* Check for LA8 and/or LA16 devices with various VID/PIDs. */
167 for (i = 0; i < ARRAY_SIZE(vid_pid); i++) {
168 ret = ftdi_usb_open_desc(ftdic, vid_pid[i].vid,
169 vid_pid[i].pid, vid_pid[i].iproduct, NULL);
171 continue; /* No device found. */
173 sr_dbg("Found %s device (%04x:%04x).",
174 vid_pid[i].iproduct, vid_pid[i].vid, vid_pid[i].pid);
176 if ((ret = add_device(i, vid_pid[i].model, &devices)) < 0)
177 sr_dbg("Failed to add device: %d.", ret);
179 if ((ret = ftdi_usb_close(ftdic)) < 0)
180 sr_dbg("Failed to close FTDI device (%d): %s.",
181 ret, ftdi_get_error_string(ftdic));
184 /* Close USB device, deinitialize and free the FTDI context. */
191 static GSList *dev_list(void)
193 return ((struct drv_context *)(di->priv))->instances;
196 static int dev_open(struct sr_dev_inst *sdi)
198 struct dev_context *devc;
203 if (!(devc = sdi->priv))
206 /* Allocate memory for the FTDI context and initialize it. */
207 if (!(devc->ftdic = ftdi_new())) {
208 sr_err("Failed to initialize libftdi.");
212 sr_dbg("Opening %s device (%04x:%04x).", devc->prof->modelname,
213 devc->usb_vid, devc->usb_pid);
215 /* Open the device. */
216 if ((ret = ftdi_usb_open_desc(devc->ftdic, devc->usb_vid,
217 devc->usb_pid, devc->prof->iproduct, NULL)) < 0) {
218 sr_err("Failed to open FTDI device (%d): %s.",
219 ret, ftdi_get_error_string(devc->ftdic));
222 sr_dbg("Device opened successfully.");
224 /* Purge RX/TX buffers in the FTDI chip. */
225 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
226 sr_err("Failed to purge FTDI buffers (%d): %s.",
227 ret, ftdi_get_error_string(devc->ftdic));
230 sr_dbg("FTDI buffers purged successfully.");
232 /* Enable flow control in the FTDI chip. */
233 if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
234 sr_err("Failed to enable FTDI flow control (%d): %s.",
235 ret, ftdi_get_error_string(devc->ftdic));
238 sr_dbg("FTDI flow control enabled successfully.");
241 g_usleep(100 * 1000);
243 sdi->status = SR_ST_ACTIVE;
248 ftdi_free(devc->ftdic); /* Close device (if open), free FTDI context. */
253 static int dev_close(struct sr_dev_inst *sdi)
256 struct dev_context *devc;
258 if (sdi->status != SR_ST_ACTIVE)
263 if (devc->ftdic && (ret = ftdi_usb_close(devc->ftdic)) < 0)
264 sr_err("Failed to close FTDI device (%d): %s.",
265 ret, ftdi_get_error_string(devc->ftdic));
266 sdi->status = SR_ST_INACTIVE;
271 static int cleanup(void)
276 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
277 const struct sr_channel_group *cg)
279 struct dev_context *devc;
284 case SR_CONF_SAMPLERATE:
285 if (!sdi || !(devc = sdi->priv))
287 *data = g_variant_new_uint64(devc->cur_samplerate);
296 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
297 const struct sr_channel_group *cg)
299 struct dev_context *devc;
303 if (sdi->status != SR_ST_ACTIVE)
304 return SR_ERR_DEV_CLOSED;
306 if (!(devc = sdi->priv))
310 case SR_CONF_SAMPLERATE:
311 if (cv_set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
314 case SR_CONF_LIMIT_MSEC:
315 if (g_variant_get_uint64(data) == 0)
317 devc->limit_msec = g_variant_get_uint64(data);
319 case SR_CONF_LIMIT_SAMPLES:
320 if (g_variant_get_uint64(data) == 0)
322 devc->limit_samples = g_variant_get_uint64(data);
331 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
332 const struct sr_channel_group *cg)
334 GVariant *gvar, *grange[2];
336 struct dev_context *devc;
341 case SR_CONF_DEVICE_OPTIONS:
342 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
343 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
345 case SR_CONF_SAMPLERATE:
346 if (!sdi || !sdi->priv || !(devc = sdi->priv))
348 cv_fill_samplerates_if_needed(sdi);
349 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
350 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
352 ARRAY_SIZE(devc->samplerates),
354 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
355 *data = g_variant_builder_end(&gvb);
357 case SR_CONF_LIMIT_SAMPLES:
358 grange[0] = g_variant_new_uint64(0);
359 grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES);
360 *data = g_variant_new_tuple(grange, 2);
362 case SR_CONF_TRIGGER_TYPE:
363 if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
365 *data = g_variant_new_string(devc->prof->trigger_type);
374 static int receive_data(int fd, int revents, void *cb_data)
377 struct sr_dev_inst *sdi;
378 struct dev_context *devc;
383 if (!(sdi = cb_data)) {
384 sr_err("cb_data was NULL.");
388 if (!(devc = sdi->priv)) {
389 sr_err("sdi->priv was NULL.");
394 sr_err("devc->ftdic was NULL.");
398 /* Get one block of data. */
399 if ((ret = cv_read_block(devc)) < 0) {
400 sr_err("Failed to read data block: %d.", ret);
401 dev_acquisition_stop(sdi, sdi);
405 /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
406 if (devc->block_counter != (NUM_BLOCKS - 1)) {
407 devc->block_counter++;
411 sr_dbg("Sampling finished, sending data to session bus now.");
414 * All data was received and demangled, send it to the session bus.
416 * Note: Due to the method how data is spread across the 8MByte of
417 * SDRAM, we can _not_ send it to the session bus in a streaming
418 * manner while we receive it. We have to receive and de-mangle the
419 * full 8MByte first, only then the whole buffer contains valid data.
421 for (i = 0; i < NUM_BLOCKS; i++)
422 cv_send_block_to_session_bus(devc, i);
424 dev_acquisition_stop(sdi, sdi);
429 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
431 struct dev_context *devc;
433 int bytes_to_write, bytes_written;
435 if (sdi->status != SR_ST_ACTIVE)
436 return SR_ERR_DEV_CLOSED;
438 if (!(devc = sdi->priv)) {
439 sr_err("sdi->priv was NULL.");
444 sr_err("devc->ftdic was NULL.");
448 devc->divcount = cv_samplerate_to_divcount(sdi, devc->cur_samplerate);
449 if (devc->divcount == 0xff) {
450 sr_err("Invalid divcount/samplerate.");
454 if (cv_configure_channels(sdi) != SR_OK) {
455 sr_err("Failed to configure channels.");
459 /* Fill acquisition parameters into buf[]. */
460 if (devc->prof->model == CHRONOVU_LA8) {
461 buf[0] = devc->divcount;
462 buf[1] = 0xff; /* This byte must always be 0xff. */
463 buf[2] = devc->trigger_pattern & 0xff;
464 buf[3] = devc->trigger_mask & 0xff;
467 buf[0] = devc->divcount;
468 buf[1] = 0xff; /* This byte must always be 0xff. */
469 buf[2] = (devc->trigger_pattern & 0xff00) >> 8; /* LSB */
470 buf[3] = (devc->trigger_pattern & 0x00ff) >> 0; /* MSB */
471 buf[4] = (devc->trigger_mask & 0xff00) >> 8; /* LSB */
472 buf[5] = (devc->trigger_mask & 0x00ff) >> 0; /* MSB */
473 buf[6] = (devc->trigger_edgemask & 0xff00) >> 8; /* LSB */
474 buf[7] = (devc->trigger_edgemask & 0x00ff) >> 0; /* MSB */
478 /* Start acquisition. */
479 bytes_written = cv_write(devc, buf, bytes_to_write);
481 if (bytes_written < 0 || bytes_written != bytes_to_write) {
482 sr_err("Acquisition failed to start.");
486 sr_dbg("Hardware acquisition started successfully.");
488 devc->cb_data = cb_data;
490 /* Send header packet to the session bus. */
491 std_session_send_df_header(cb_data, LOG_PREFIX);
493 /* Time when we should be done (for detecting trigger timeouts). */
494 devc->done = (devc->divcount + 1) * devc->prof->trigger_constant +
495 g_get_monotonic_time() + (10 * G_TIME_SPAN_SECOND);
496 devc->block_counter = 0;
497 devc->trigger_found = 0;
499 /* Hook up a dummy handler to receive data from the device. */
500 sr_source_add(-1, G_IO_IN, 0, receive_data, (void *)sdi);
505 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
507 struct sr_datafeed_packet packet;
511 sr_dbg("Stopping acquisition.");
512 sr_source_remove(-1);
514 /* Send end packet to the session bus. */
515 sr_dbg("Sending SR_DF_END.");
516 packet.type = SR_DF_END;
517 sr_session_send(cb_data, &packet);
522 SR_PRIV struct sr_dev_driver chronovu_la_driver_info = {
523 .name = "chronovu-la",
524 .longname = "ChronoVu LA8/LA16",
529 .dev_list = dev_list,
530 .dev_clear = dev_clear,
531 .config_get = config_get,
532 .config_set = config_set,
533 .config_list = config_list,
534 .dev_open = dev_open,
535 .dev_close = dev_close,
536 .dev_acquisition_start = dev_acquisition_start,
537 .dev_acquisition_stop = dev_acquisition_stop,