2 * This file is part of the libsigrok project.
4 * Copyright (C) 2011-2012 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 #include "libsigrok.h"
25 #include "libsigrok-internal.h"
28 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
29 static struct sr_dev_driver *di = &chronovu_la8_driver_info;
32 * This will be initialized via config_list()/SR_CONF_SAMPLERATE.
34 * Min: 1 sample per 0.01us -> sample time is 0.084s, samplerate 100MHz
35 * Max: 1 sample per 2.55us -> sample time is 21.391s, samplerate 392.15kHz
37 SR_PRIV uint64_t chronovu_la8_samplerates[255] = { 0 };
39 /* Note: Continuous sampling is not supported by the hardware. */
40 SR_PRIV const int32_t chronovu_la8_hwcaps[] = {
41 SR_CONF_LOGIC_ANALYZER,
43 SR_CONF_LIMIT_MSEC, /* TODO: Not yet implemented. */
44 SR_CONF_LIMIT_SAMPLES, /* TODO: Not yet implemented. */
48 * The ChronoVu LA8 can have multiple PIDs. Older versions shipped with
49 * a standard FTDI USB VID/PID of 0403:6001, newer ones have 0403:8867.
51 static const uint16_t usb_pids[] = {
56 /* Function prototypes. */
57 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
59 static int clear_instances(void)
62 struct sr_dev_inst *sdi;
63 struct drv_context *drvc;
64 struct dev_context *devc;
68 /* Properly close all devices. */
69 for (l = drvc->instances; l; l = l->next) {
70 if (!(sdi = l->data)) {
71 /* Log error, but continue cleaning up the rest. */
72 sr_err("%s: sdi was NULL, continuing.", __func__);
77 ftdi_free(devc->ftdic);
79 sr_dev_inst_free(sdi);
81 g_slist_free(drvc->instances);
82 drvc->instances = NULL;
87 static int hw_init(struct sr_context *sr_ctx)
89 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
92 static GSList *hw_scan(GSList *options)
94 struct sr_dev_inst *sdi;
95 struct sr_probe *probe;
96 struct drv_context *drvc;
97 struct dev_context *devc;
108 /* Allocate memory for our private device context. */
109 if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
110 sr_err("Device context malloc failed.");
111 goto err_free_nothing;
114 /* Set some sane defaults. */
116 devc->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
117 devc->limit_msec = 0;
118 devc->limit_samples = 0;
119 devc->cb_data = NULL;
120 memset(devc->mangled_buf, 0, BS);
121 devc->final_buf = NULL;
122 devc->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
123 devc->trigger_mask = 0x00; /* All probes are "don't care". */
124 devc->trigger_timeout = 10; /* Default to 10s trigger timeout. */
125 devc->trigger_found = 0;
127 devc->block_counter = 0;
128 devc->divcount = 0; /* 10ns sample period == 100MHz samplerate */
131 /* Allocate memory where we'll store the de-mangled data. */
132 if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
133 sr_err("final_buf malloc failed.");
137 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
138 if (!(devc->ftdic = ftdi_new())) {
139 sr_err("%s: ftdi_new failed.", __func__);
140 goto err_free_final_buf;
143 /* Check for the device and temporarily open it. */
144 for (i = 0; i < ARRAY_SIZE(usb_pids); i++) {
145 sr_dbg("Probing for VID/PID %04x:%04x.", USB_VENDOR_ID,
147 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
148 usb_pids[i], USB_DESCRIPTION, NULL);
150 sr_dbg("Found LA8 device (%04x:%04x).",
151 USB_VENDOR_ID, usb_pids[i]);
152 devc->usb_pid = usb_pids[i];
156 if (devc->usb_pid == 0)
159 /* Register the device with libsigrok. */
160 sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
161 USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
163 sr_err("%s: sr_dev_inst_new failed.", __func__);
164 goto err_close_ftdic;
169 for (i = 0; chronovu_la8_probe_names[i]; i++) {
170 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
171 chronovu_la8_probe_names[i])))
173 sdi->probes = g_slist_append(sdi->probes, probe);
176 devices = g_slist_append(devices, sdi);
177 drvc->instances = g_slist_append(drvc->instances, sdi);
179 /* Close device. We'll reopen it again when we need it. */
180 (void) la8_close(devc); /* Log, but ignore errors. */
185 (void) la8_close(devc); /* Log, but ignore errors. */
187 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
189 g_free(devc->final_buf);
197 static GSList *hw_dev_list(void)
199 return ((struct drv_context *)(di->priv))->instances;
202 static int hw_dev_open(struct sr_dev_inst *sdi)
204 struct dev_context *devc;
207 if (!(devc = sdi->priv)) {
208 sr_err("%s: sdi->priv was NULL.", __func__);
212 sr_dbg("Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
215 /* Open the device. */
216 if ((ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
217 devc->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
218 sr_err("%s: ftdi_usb_open_desc: (%d) %s",
219 __func__, ret, ftdi_get_error_string(devc->ftdic));
220 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
223 sr_dbg("Device opened successfully.");
225 /* Purge RX/TX buffers in the FTDI chip. */
226 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
227 sr_err("%s: ftdi_usb_purge_buffers: (%d) %s",
228 __func__, ret, ftdi_get_error_string(devc->ftdic));
229 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
230 goto err_dev_open_close_ftdic;
232 sr_dbg("FTDI buffers purged successfully.");
234 /* Enable flow control in the FTDI chip. */
235 if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
236 sr_err("%s: ftdi_setflowcontrol: (%d) %s",
237 __func__, ret, ftdi_get_error_string(devc->ftdic));
238 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
239 goto err_dev_open_close_ftdic;
241 sr_dbg("FTDI flow control enabled successfully.");
244 g_usleep(100 * 1000);
246 sdi->status = SR_ST_ACTIVE;
250 err_dev_open_close_ftdic:
251 (void) la8_close(devc); /* Log, but ignore errors. */
255 static int hw_dev_close(struct sr_dev_inst *sdi)
257 struct dev_context *devc;
261 if (sdi->status == SR_ST_ACTIVE) {
262 sr_dbg("Status ACTIVE, closing device.");
263 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
265 sr_spew("Status not ACTIVE, nothing to do.");
268 sdi->status = SR_ST_INACTIVE;
270 g_free(devc->final_buf);
275 static int hw_cleanup(void)
278 /* Can get called on an unused driver, doesn't matter. */
286 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
288 struct dev_context *devc;
291 case SR_CONF_SAMPLERATE:
294 *data = g_variant_new_uint64(devc->cur_samplerate);
295 sr_spew("%s: Returning samplerate: %" PRIu64 "Hz.",
296 __func__, devc->cur_samplerate);
307 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
309 struct dev_context *devc;
311 if (!(devc = sdi->priv)) {
312 sr_err("%s: sdi->priv was NULL.", __func__);
317 case SR_CONF_SAMPLERATE:
318 if (set_samplerate(sdi, g_variant_get_uint64(data)) == SR_ERR) {
319 sr_err("%s: setting samplerate failed.", __func__);
322 sr_dbg("SAMPLERATE = %" PRIu64, devc->cur_samplerate);
324 case SR_CONF_LIMIT_MSEC:
325 if (g_variant_get_uint64(data) == 0) {
326 sr_err("%s: LIMIT_MSEC can't be 0.", __func__);
329 devc->limit_msec = g_variant_get_uint64(data);
330 sr_dbg("LIMIT_MSEC = %" PRIu64, devc->limit_msec);
332 case SR_CONF_LIMIT_SAMPLES:
333 if (g_variant_get_uint64(data) < MIN_NUM_SAMPLES) {
334 sr_err("%s: LIMIT_SAMPLES too small.", __func__);
337 devc->limit_samples = g_variant_get_uint64(data);
338 sr_dbg("LIMIT_SAMPLES = %" PRIu64, devc->limit_samples);
347 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
355 case SR_CONF_DEVICE_OPTIONS:
356 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
358 ARRAY_SIZE(chronovu_la8_hwcaps),
361 case SR_CONF_SAMPLERATE:
362 fill_supported_samplerates_if_needed();
363 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
364 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
365 chronovu_la8_samplerates,
366 ARRAY_SIZE(chronovu_la8_samplerates),
368 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
369 *data = g_variant_builder_end(&gvb);
371 case SR_CONF_TRIGGER_TYPE:
372 *data = g_variant_new_string(TRIGGER_TYPE);
381 static int receive_data(int fd, int revents, void *cb_data)
384 struct sr_dev_inst *sdi;
385 struct dev_context *devc;
390 if (!(sdi = cb_data)) {
391 sr_err("%s: cb_data was NULL.", __func__);
395 if (!(devc = sdi->priv)) {
396 sr_err("%s: sdi->priv was NULL.", __func__);
401 sr_err("%s: devc->ftdic was NULL.", __func__);
405 /* Get one block of data. */
406 if ((ret = la8_read_block(devc)) < 0) {
407 sr_err("%s: la8_read_block error: %d.", __func__, ret);
408 hw_dev_acquisition_stop(sdi, sdi);
412 /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
413 if (devc->block_counter != (NUM_BLOCKS - 1)) {
414 devc->block_counter++;
418 sr_dbg("Sampling finished, sending data to session bus now.");
420 /* All data was received and demangled, send it to the session bus. */
421 for (i = 0; i < NUM_BLOCKS; i++)
422 send_block_to_session_bus(devc, i);
424 hw_dev_acquisition_stop(sdi, sdi);
429 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
432 struct dev_context *devc;
436 if (!(devc = sdi->priv)) {
437 sr_err("%s: sdi->priv was NULL.", __func__);
442 sr_err("%s: devc->ftdic was NULL.", __func__);
446 devc->divcount = samplerate_to_divcount(devc->cur_samplerate);
447 if (devc->divcount == 0xff) {
448 sr_err("%s: Invalid divcount/samplerate.", __func__);
452 if (configure_probes(sdi) != SR_OK) {
453 sr_err("Failed to configure probes.");
457 /* Fill acquisition parameters into buf[]. */
458 buf[0] = devc->divcount;
459 buf[1] = 0xff; /* This byte must always be 0xff. */
460 buf[2] = devc->trigger_pattern;
461 buf[3] = devc->trigger_mask;
463 /* Start acquisition. */
464 bytes_written = la8_write(devc, buf, 4);
466 if (bytes_written < 0) {
467 sr_err("Acquisition failed to start: %d.", bytes_written);
469 } else if (bytes_written != 4) {
470 sr_err("Acquisition failed to start: %d.", bytes_written);
474 sr_dbg("Hardware acquisition started successfully.");
476 devc->cb_data = cb_data;
478 /* Send header packet to the session bus. */
479 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
481 /* Time when we should be done (for detecting trigger timeouts). */
482 devc->done = (devc->divcount + 1) * 0.08388608 + time(NULL)
483 + devc->trigger_timeout;
484 devc->block_counter = 0;
485 devc->trigger_found = 0;
487 /* Hook up a dummy handler to receive data from the LA8. */
488 sr_source_add(-1, G_IO_IN, 0, receive_data, (void *)sdi);
493 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
495 struct sr_datafeed_packet packet;
499 sr_dbg("Stopping acquisition.");
500 sr_source_remove(-1);
502 /* Send end packet to the session bus. */
503 sr_dbg("Sending SR_DF_END.");
504 packet.type = SR_DF_END;
505 sr_session_send(cb_data, &packet);
510 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = {
511 .name = "chronovu-la8",
512 .longname = "ChronoVu LA8",
515 .cleanup = hw_cleanup,
517 .dev_list = hw_dev_list,
518 .dev_clear = clear_instances,
519 .config_get = config_get,
520 .config_set = config_set,
521 .config_list = config_list,
522 .dev_open = hw_dev_open,
523 .dev_close = hw_dev_close,
524 .dev_acquisition_start = hw_dev_acquisition_start,
525 .dev_acquisition_stop = hw_dev_acquisition_stop,