2 * This file is part of the sigrok 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 *cdi = &chronovu_la8_driver_info;
32 * The ChronoVu LA8 can have multiple PIDs. Older versions shipped with
33 * a standard FTDI USB VID/PID of 0403:6001, newer ones have 0403:8867.
35 static const uint16_t usb_pids[] = {
40 /* Function prototypes. */
41 static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
43 static void clear_instances(void)
46 struct sr_dev_inst *sdi;
49 /* Properly close all devices. */
50 for (l = cdi->instances; l; l = l->next) {
51 if (!(sdi = l->data)) {
52 /* Log error, but continue cleaning up the rest. */
53 sr_err("la8: %s: sdi was NULL, continuing", __func__);
58 ftdi_free(ctx->ftdic);
61 sr_dev_inst_free(sdi);
63 g_slist_free(cdi->instances);
64 cdi->instances = NULL;
68 static int hw_init(void)
76 static GSList *hw_scan(GSList *options)
79 struct sr_dev_inst *sdi;
86 /* Allocate memory for our private driver context. */
87 if (!(ctx = g_try_malloc(sizeof(struct context)))) {
88 sr_err("la8: %s: struct context malloc failed", __func__);
89 goto err_free_nothing;
92 /* Set some sane defaults. */
94 ctx->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
96 ctx->limit_samples = 0;
97 ctx->session_dev_id = NULL;
98 memset(ctx->mangled_buf, 0, BS);
99 ctx->final_buf = NULL;
100 ctx->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
101 ctx->trigger_mask = 0x00; /* All probes are "don't care". */
102 ctx->trigger_timeout = 10; /* Default to 10s trigger timeout. */
103 ctx->trigger_found = 0;
105 ctx->block_counter = 0;
106 ctx->divcount = 0; /* 10ns sample period == 100MHz samplerate */
109 /* Allocate memory where we'll store the de-mangled data. */
110 if (!(ctx->final_buf = g_try_malloc(SDRAM_SIZE))) {
111 sr_err("la8: %s: final_buf malloc failed", __func__);
115 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
116 if (!(ctx->ftdic = ftdi_new())) {
117 sr_err("la8: %s: ftdi_new failed", __func__);
118 goto err_free_final_buf;
121 /* Check for the device and temporarily open it. */
122 for (i = 0; i < ARRAY_SIZE(usb_pids); i++) {
123 sr_dbg("la8: Probing for VID/PID %04x:%04x.", USB_VENDOR_ID,
125 ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
126 usb_pids[i], USB_DESCRIPTION, NULL);
128 sr_dbg("la8: Found LA8 device (%04x:%04x).",
129 USB_VENDOR_ID, usb_pids[i]);
130 ctx->usb_pid = usb_pids[i];
134 if (ctx->usb_pid == 0)
137 /* Register the device with libsigrok. */
138 sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
139 USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
141 sr_err("la8: %s: sr_dev_inst_new failed", __func__);
142 goto err_close_ftdic;
147 devices = g_slist_append(devices, sdi);
148 cdi->instances = g_slist_append(cdi->instances, sdi);
150 sr_spew("la8: Device init successful.");
152 /* Close device. We'll reopen it again when we need it. */
153 (void) la8_close(ctx); /* Log, but ignore errors. */
158 (void) la8_close(ctx); /* Log, but ignore errors. */
160 free(ctx->ftdic); /* NOT g_free()! */
162 g_free(ctx->final_buf);
170 static int hw_dev_open(int dev_index)
173 struct sr_dev_inst *sdi;
176 if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
177 sr_err("la8: %s: sdi was NULL", __func__);
181 if (!(ctx = sdi->priv)) {
182 sr_err("la8: %s: sdi->priv was NULL", __func__);
186 sr_dbg("la8: Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
189 /* Open the device. */
190 if ((ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
191 ctx->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
192 sr_err("la8: %s: ftdi_usb_open_desc: (%d) %s",
193 __func__, ret, ftdi_get_error_string(ctx->ftdic));
194 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
197 sr_dbg("la8: Device opened successfully.");
199 /* Purge RX/TX buffers in the FTDI chip. */
200 if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0) {
201 sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
202 __func__, ret, ftdi_get_error_string(ctx->ftdic));
203 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
204 goto err_dev_open_close_ftdic;
206 sr_dbg("la8: FTDI buffers purged successfully.");
208 /* Enable flow control in the FTDI chip. */
209 if ((ret = ftdi_setflowctrl(ctx->ftdic, SIO_RTS_CTS_HS)) < 0) {
210 sr_err("la8: %s: ftdi_setflowcontrol: (%d) %s",
211 __func__, ret, ftdi_get_error_string(ctx->ftdic));
212 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
213 goto err_dev_open_close_ftdic;
215 sr_dbg("la8: FTDI flow control enabled successfully.");
218 g_usleep(100 * 1000);
220 sdi->status = SR_ST_ACTIVE;
224 err_dev_open_close_ftdic:
225 (void) la8_close(ctx); /* Log, but ignore errors. */
229 static int hw_dev_close(int dev_index)
231 struct sr_dev_inst *sdi;
234 if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
235 sr_err("la8: %s: sdi was NULL", __func__);
239 if (!(ctx = sdi->priv)) {
240 sr_err("la8: %s: sdi->priv was NULL", __func__);
244 sr_dbg("la8: Closing device.");
246 if (sdi->status == SR_ST_ACTIVE) {
247 sr_dbg("la8: Status ACTIVE, closing device.");
248 /* TODO: Really ignore errors here, or return SR_ERR? */
249 (void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
251 sr_spew("la8: Status not ACTIVE, nothing to do.");
254 sdi->status = SR_ST_INACTIVE;
256 sr_dbg("la8: Freeing sample buffer.");
257 g_free(ctx->final_buf);
262 static int hw_cleanup(void)
270 static int hw_info_get(int info_id, const void **data,
271 const struct sr_dev_inst *sdi)
278 sr_spew("la8: %s: Returning sdi.", __func__);
280 case SR_DI_NUM_PROBES:
281 *data = GINT_TO_POINTER(NUM_PROBES);
282 sr_spew("la8: %s: Returning number of probes: %d.", __func__,
285 case SR_DI_PROBE_NAMES:
287 sr_spew("la8: %s: Returning probenames.", __func__);
289 case SR_DI_SAMPLERATES:
290 fill_supported_samplerates_if_needed();
291 *data = &samplerates;
292 sr_spew("la8: %s: Returning samplerates.", __func__);
294 case SR_DI_TRIGGER_TYPES:
295 *data = (char *)TRIGGER_TYPES;
296 sr_spew("la8: %s: Returning trigger types: %s.", __func__,
299 case SR_DI_CUR_SAMPLERATE:
302 *data = &ctx->cur_samplerate;
303 sr_spew("la8: %s: Returning samplerate: %" PRIu64 "Hz.",
304 __func__, ctx->cur_samplerate);
313 static int hw_dev_status_get(int dev_index)
315 struct sr_dev_inst *sdi;
317 if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
318 sr_err("la8: %s: sdi was NULL, device not found", __func__);
319 return SR_ST_NOT_FOUND;
322 sr_dbg("la8: Returning status: %d.", sdi->status);
327 static const int *hw_hwcap_get_all(void)
329 sr_spew("la8: Returning list of device capabilities.");
334 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
336 struct sr_dev_inst *sdi;
339 if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
340 sr_err("la8: %s: sdi was NULL", __func__);
344 if (!(ctx = sdi->priv)) {
345 sr_err("la8: %s: sdi->priv was NULL", __func__);
349 sr_spew("la8: %s: dev_index %d, hwcap %d", __func__, dev_index, hwcap);
352 case SR_HWCAP_SAMPLERATE:
353 if (set_samplerate(sdi, *(const uint64_t *)value) == SR_ERR) {
354 sr_err("la8: %s: setting samplerate failed.", __func__);
357 sr_dbg("la8: SAMPLERATE = %" PRIu64, ctx->cur_samplerate);
359 case SR_HWCAP_PROBECONFIG:
360 if (configure_probes(ctx, (const GSList *)value) != SR_OK) {
361 sr_err("la8: %s: probe config failed.", __func__);
365 case SR_HWCAP_LIMIT_MSEC:
366 if (*(const uint64_t *)value == 0) {
367 sr_err("la8: %s: LIMIT_MSEC can't be 0.", __func__);
370 ctx->limit_msec = *(const uint64_t *)value;
371 sr_dbg("la8: LIMIT_MSEC = %" PRIu64, ctx->limit_msec);
373 case SR_HWCAP_LIMIT_SAMPLES:
374 if (*(const uint64_t *)value < MIN_NUM_SAMPLES) {
375 sr_err("la8: %s: LIMIT_SAMPLES too small.", __func__);
378 ctx->limit_samples = *(const uint64_t *)value;
379 sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, ctx->limit_samples);
382 /* Unknown capability, return SR_ERR. */
383 sr_err("la8: %s: Unknown capability.", __func__);
391 static int receive_data(int fd, int revents, void *cb_data)
394 struct sr_dev_inst *sdi;
397 /* Avoid compiler errors. */
401 if (!(sdi = cb_data)) {
402 sr_err("la8: %s: cb_data was NULL", __func__);
406 if (!(ctx = sdi->priv)) {
407 sr_err("la8: %s: sdi->priv was NULL", __func__);
412 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
416 /* Get one block of data. */
417 if ((ret = la8_read_block(ctx)) < 0) {
418 sr_err("la8: %s: la8_read_block error: %d", __func__, ret);
419 hw_dev_acquisition_stop(sdi->index, sdi);
423 /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
424 if (ctx->block_counter != (NUM_BLOCKS - 1)) {
425 ctx->block_counter++;
429 sr_dbg("la8: Sampling finished, sending data to session bus now.");
431 /* All data was received and demangled, send it to the session bus. */
432 for (i = 0; i < NUM_BLOCKS; i++)
433 send_block_to_session_bus(ctx, i);
435 hw_dev_acquisition_stop(sdi->index, sdi);
437 // return FALSE; /* FIXME? */
441 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
443 struct sr_dev_inst *sdi;
445 struct sr_datafeed_packet packet;
446 struct sr_datafeed_header header;
447 struct sr_datafeed_meta_logic meta;
451 if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
452 sr_err("la8: %s: sdi was NULL", __func__);
456 if (!(ctx = sdi->priv)) {
457 sr_err("la8: %s: sdi->priv was NULL", __func__);
462 sr_err("la8: %s: ctx->ftdic was NULL", __func__);
466 ctx->divcount = samplerate_to_divcount(ctx->cur_samplerate);
467 if (ctx->divcount == 0xff) {
468 sr_err("la8: %s: invalid divcount/samplerate", __func__);
472 sr_dbg("la8: Starting acquisition.");
474 /* Fill acquisition parameters into buf[]. */
475 buf[0] = ctx->divcount;
476 buf[1] = 0xff; /* This byte must always be 0xff. */
477 buf[2] = ctx->trigger_pattern;
478 buf[3] = ctx->trigger_mask;
480 /* Start acquisition. */
481 bytes_written = la8_write(ctx, buf, 4);
483 if (bytes_written < 0) {
484 sr_err("la8: Acquisition failed to start.");
486 } else if (bytes_written != 4) {
487 sr_err("la8: Acquisition failed to start.");
488 return SR_ERR; /* TODO: Other error and return code? */
491 sr_dbg("la8: Acquisition started successfully.");
493 ctx->session_dev_id = cb_data;
495 /* Send header packet to the session bus. */
496 sr_dbg("la8: Sending SR_DF_HEADER.");
497 packet.type = SR_DF_HEADER;
498 packet.payload = &header;
499 header.feed_version = 1;
500 gettimeofday(&header.starttime, NULL);
501 sr_session_send(ctx->session_dev_id, &packet);
503 /* Send metadata about the SR_DF_LOGIC packets to come. */
504 packet.type = SR_DF_META_LOGIC;
505 packet.payload = &meta;
506 meta.samplerate = ctx->cur_samplerate;
507 meta.num_probes = NUM_PROBES;
508 sr_session_send(ctx->session_dev_id, &packet);
510 /* Time when we should be done (for detecting trigger timeouts). */
511 ctx->done = (ctx->divcount + 1) * 0.08388608 + time(NULL)
512 + ctx->trigger_timeout;
513 ctx->block_counter = 0;
514 ctx->trigger_found = 0;
516 /* Hook up a dummy handler to receive data from the LA8. */
517 sr_source_add(-1, G_IO_IN, 0, receive_data, sdi);
522 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
524 struct sr_dev_inst *sdi;
526 struct sr_datafeed_packet packet;
528 sr_dbg("la8: Stopping acquisition.");
530 if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
531 sr_err("la8: %s: sdi was NULL", __func__);
535 if (!(ctx = sdi->priv)) {
536 sr_err("la8: %s: sdi->priv was NULL", __func__);
540 /* Send end packet to the session bus. */
541 sr_dbg("la8: Sending SR_DF_END.");
542 packet.type = SR_DF_END;
543 sr_session_send(cb_data, &packet);
548 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = {
549 .name = "chronovu-la8",
550 .longname = "ChronoVu LA8",
553 .cleanup = hw_cleanup,
555 .dev_open = hw_dev_open,
556 .dev_close = hw_dev_close,
557 .info_get = hw_info_get,
558 .dev_status_get = hw_dev_status_get,
559 // .hwcap_get_all = hw_hwcap_get_all,
560 .dev_config_set = hw_dev_config_set,
561 .dev_acquisition_start = hw_dev_acquisition_start,
562 .dev_acquisition_stop = hw_dev_acquisition_stop,