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
23 #include "libsigrok.h"
24 #include "libsigrok-internal.h"
27 /* Probes are numbered 0-7. */
28 SR_PRIV const char *chronovu_la8_channel_names[NUM_PROBES + 1] = {
29 "0", "1", "2", "3", "4", "5", "6", "7",
33 SR_PRIV void fill_supported_samplerates_if_needed(void)
37 if (chronovu_la8_samplerates[0] != 0)
40 for (i = 0; i < 255; i++)
41 chronovu_la8_samplerates[254 - i] = SR_MHZ(100) / (i + 1);
45 * Check if the given samplerate is supported by the LA8 hardware.
47 * @param samplerate The samplerate (in Hz) to check.
48 * @return 1 if the samplerate is supported/valid, 0 otherwise.
50 SR_PRIV int is_valid_samplerate(uint64_t samplerate)
54 fill_supported_samplerates_if_needed();
56 for (i = 0; i < 255; i++) {
57 if (chronovu_la8_samplerates[i] == samplerate)
61 sr_err("Invalid samplerate (%" PRIu64 "Hz).", samplerate);
67 * Convert a samplerate (in Hz) to the 'divcount' value the LA8 wants.
69 * LA8 hardware: sample period = (divcount + 1) * 10ns.
70 * Min. value for divcount: 0x00 (10ns sample period, 100MHz samplerate).
71 * Max. value for divcount: 0xfe (2550ns sample period, 392.15kHz samplerate).
73 * @param samplerate The samplerate in Hz.
74 * @return The divcount value as needed by the hardware, or 0xff upon errors.
76 SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate)
78 if (samplerate == 0) {
79 sr_err("%s: samplerate was 0.", __func__);
83 if (!is_valid_samplerate(samplerate)) {
84 sr_err("%s: Can't get divcount, samplerate invalid.", __func__);
88 return (SR_MHZ(100) / samplerate) - 1;
92 * Write data of a certain length to the LA8's FTDI device.
94 * @param devc The struct containing private per-device-instance data. Must not
95 * be NULL. devc->ftdic must not be NULL either.
96 * @param buf The buffer containing the data to write. Must not be NULL.
97 * @param size The number of bytes to write. Must be >= 0.
98 * @return The number of bytes written, or a negative value upon errors.
100 SR_PRIV int la8_write(struct dev_context *devc, uint8_t *buf, int size)
104 /* Note: Caller checked that devc and devc->ftdic != NULL. */
107 sr_err("%s: buf was NULL.", __func__);
112 sr_err("%s: size was < 0.", __func__);
116 bytes_written = ftdi_write_data(devc->ftdic, buf, size);
118 if (bytes_written < 0) {
119 sr_err("%s: ftdi_write_data: (%d) %s.", __func__,
120 bytes_written, ftdi_get_error_string(devc->ftdic));
121 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
122 } else if (bytes_written != size) {
123 sr_err("%s: bytes to write: %d, bytes written: %d.",
124 __func__, size, bytes_written);
125 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
128 return bytes_written;
132 * Read a certain amount of bytes from the LA8's FTDI device.
134 * @param devc The struct containing private per-device-instance data. Must not
135 * be NULL. devc->ftdic must not be NULL either.
136 * @param buf The buffer where the received data will be stored. Must not
138 * @param size The number of bytes to read. Must be >= 1.
139 * @return The number of bytes read, or a negative value upon errors.
141 SR_PRIV int la8_read(struct dev_context *devc, uint8_t *buf, int size)
145 /* Note: Caller checked that devc and devc->ftdic != NULL. */
148 sr_err("%s: buf was NULL.", __func__);
153 sr_err("%s: size was <= 0.", __func__);
157 bytes_read = ftdi_read_data(devc->ftdic, buf, size);
159 if (bytes_read < 0) {
160 sr_err("%s: ftdi_read_data: (%d) %s.", __func__,
161 bytes_read, ftdi_get_error_string(devc->ftdic));
162 } else if (bytes_read != size) {
163 // sr_err("%s: Bytes to read: %d, bytes read: %d.",
164 // __func__, size, bytes_read);
170 SR_PRIV int la8_close(struct dev_context *devc)
175 sr_err("%s: devc was NULL.", __func__);
180 sr_err("%s: devc->ftdic was NULL.", __func__);
184 if ((ret = ftdi_usb_close(devc->ftdic)) < 0) {
185 sr_err("%s: ftdi_usb_close: (%d) %s.",
186 __func__, ret, ftdi_get_error_string(devc->ftdic));
193 * Close the ChronoVu LA8 USB port and reset the LA8 sequencer logic.
195 * @param devc The struct containing private per-device-instance data.
196 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
198 SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc)
200 /* Magic sequence of bytes for resetting the LA8 sequencer logic. */
201 uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01};
205 sr_err("%s: devc was NULL.", __func__);
210 sr_err("%s: devc->ftdic was NULL.", __func__);
214 if (devc->ftdic->usb_dev) {
215 /* Reset the LA8 sequencer logic, then wait 100ms. */
216 sr_dbg("Resetting sequencer logic.");
217 (void) la8_write(devc, buf, 8); /* Ignore errors. */
218 g_usleep(100 * 1000);
220 /* Purge FTDI buffers, then reset and close the FTDI device. */
221 sr_dbg("Purging buffers, resetting+closing FTDI device.");
223 /* Log errors, but ignore them (i.e., don't abort). */
224 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0)
225 sr_err("%s: ftdi_usb_purge_buffers: (%d) %s.",
226 __func__, ret, ftdi_get_error_string(devc->ftdic));
227 if ((ret = ftdi_usb_reset(devc->ftdic)) < 0)
228 sr_err("%s: ftdi_usb_reset: (%d) %s.", __func__,
229 ret, ftdi_get_error_string(devc->ftdic));
230 if ((ret = ftdi_usb_close(devc->ftdic)) < 0)
231 sr_err("%s: ftdi_usb_close: (%d) %s.", __func__,
232 ret, ftdi_get_error_string(devc->ftdic));
235 /* Close USB device, deinitialize and free the FTDI context. */
236 ftdi_free(devc->ftdic); /* Returns void. */
243 * Reset the ChronoVu LA8.
245 * The LA8 must be reset after a failed read/write operation or upon timeouts.
247 * @param devc The struct containing private per-device-instance data.
248 * @return SR_OK upon success, SR_ERR upon failure.
250 SR_PRIV int la8_reset(struct dev_context *devc)
257 sr_err("%s: devc was NULL.", __func__);
262 sr_err("%s: devc->ftdic was NULL.", __func__);
266 sr_dbg("Resetting the device.");
269 * Purge pending read data from the FTDI hardware FIFO until
270 * no more data is left, or a timeout occurs (after 20s).
272 done = 20 + time(NULL);
274 /* TODO: Ignore errors? Check for < 0 at least! */
275 bytes_read = la8_read(devc, (uint8_t *)&buf, BS);
277 } while ((done > now) && (bytes_read > 0));
279 /* Reset the LA8 sequencer logic and close the USB port. */
280 (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
282 sr_dbg("Device reset finished.");
287 SR_PRIV int configure_channels(const struct sr_dev_inst *sdi)
289 struct dev_context *devc;
290 const struct sr_channel *ch;
296 devc->trigger_pattern = 0;
297 devc->trigger_mask = 0; /* Default to "don't care" for all channels. */
299 for (l = sdi->channels; l; l = l->next) {
300 ch = (struct sr_channel *)l->data;
303 sr_err("%s: channel was NULL.", __func__);
307 /* Skip disabled channels. */
311 /* Skip (enabled) channels with no configured trigger. */
315 /* Note: Must only be run if ch->trigger != NULL. */
316 if (ch->index < 0 || ch->index > 7) {
317 sr_err("%s: Invalid channel index %d, must be "
318 "between 0 and 7.", __func__, ch->index);
322 channel_bit = (1 << (ch->index));
324 /* Configure the channel's trigger mask and trigger pattern. */
325 for (tc = ch->trigger; tc && *tc; tc++) {
326 devc->trigger_mask |= channel_bit;
328 /* Sanity check, LA8 only supports low/high trigger. */
329 if (*tc != '0' && *tc != '1') {
330 sr_err("%s: Invalid trigger '%c', only "
331 "'0'/'1' supported.", __func__, *tc);
336 devc->trigger_pattern |= channel_bit;
340 sr_dbg("Trigger mask = 0x%x, trigger pattern = 0x%x.",
341 devc->trigger_mask, devc->trigger_pattern);
346 SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
348 struct dev_context *devc;
350 /* Note: Caller checked that sdi and sdi->priv != NULL. */
354 sr_spew("Trying to set samplerate to %" PRIu64 "Hz.", samplerate);
356 fill_supported_samplerates_if_needed();
358 /* Check if this is a samplerate supported by the hardware. */
359 if (!is_valid_samplerate(samplerate))
362 /* Set the new samplerate. */
363 devc->cur_samplerate = samplerate;
365 sr_dbg("Samplerate set to %" PRIu64 "Hz.", devc->cur_samplerate);
371 * Get a block of data from the LA8.
373 * @param devc The struct containing private per-device-instance data. Must not
374 * be NULL. devc->ftdic must not be NULL either.
375 * @return SR_OK upon success, or SR_ERR upon errors.
377 SR_PRIV int la8_read_block(struct dev_context *devc)
379 int i, byte_offset, m, mi, p, index, bytes_read;
382 /* Note: Caller checked that devc and devc->ftdic != NULL. */
384 sr_spew("Reading block %d.", devc->block_counter);
386 bytes_read = la8_read(devc, devc->mangled_buf, BS);
388 /* If first block read got 0 bytes, retry until success or timeout. */
389 if ((bytes_read == 0) && (devc->block_counter == 0)) {
391 sr_spew("Reading block 0 (again).");
392 bytes_read = la8_read(devc, devc->mangled_buf, BS);
393 /* TODO: How to handle read errors here? */
395 } while ((devc->done > now) && (bytes_read == 0));
398 /* Check if block read was successful or a timeout occured. */
399 if (bytes_read != BS) {
400 sr_err("Trigger timed out. Bytes read: %d.", bytes_read);
401 (void) la8_reset(devc); /* Ignore errors. */
405 /* De-mangle the data. */
406 sr_spew("Demangling block %d.", devc->block_counter);
407 byte_offset = devc->block_counter * BS;
408 m = byte_offset / (1024 * 1024);
409 mi = m * (1024 * 1024);
410 for (i = 0; i < BS; i++) {
412 index = m * 2 + (((byte_offset + i) - mi) / 2) * 16;
413 index += (devc->divcount == 0) ? p : (1 - p);
414 devc->final_buf[index] = devc->mangled_buf[i];
420 SR_PRIV void send_block_to_session_bus(struct dev_context *devc, int block)
423 uint8_t sample, expected_sample;
424 struct sr_datafeed_packet packet;
425 struct sr_datafeed_logic logic;
426 int trigger_point; /* Relative trigger point (in this block). */
428 /* Note: No sanity checks on devc/block, caller is responsible. */
430 /* Check if we can find the trigger condition in this block. */
432 expected_sample = devc->trigger_pattern & devc->trigger_mask;
433 for (i = 0; i < BS; i++) {
434 /* Don't continue if the trigger was found previously. */
435 if (devc->trigger_found)
439 * Also, don't continue if triggers are "don't care", i.e. if
440 * no trigger conditions were specified by the user. In that
441 * case we don't want to send an SR_DF_TRIGGER packet at all.
443 if (devc->trigger_mask == 0x00)
446 sample = *(devc->final_buf + (block * BS) + i);
448 if ((sample & devc->trigger_mask) == expected_sample) {
450 devc->trigger_found = 1;
455 /* If no trigger was found, send one SR_DF_LOGIC packet. */
456 if (trigger_point == -1) {
457 /* Send an SR_DF_LOGIC packet to the session bus. */
458 sr_spew("Sending SR_DF_LOGIC packet (%d bytes) for "
459 "block %d.", BS, block);
460 packet.type = SR_DF_LOGIC;
461 packet.payload = &logic;
464 logic.data = devc->final_buf + (block * BS);
465 sr_session_send(devc->cb_data, &packet);
470 * We found the trigger, so some special handling is needed. We have
471 * to send an SR_DF_LOGIC packet with the samples before the trigger
472 * (if any), then the SD_DF_TRIGGER packet itself, then another
473 * SR_DF_LOGIC packet with the samples after the trigger (if any).
476 /* TODO: Send SR_DF_TRIGGER packet before or after the actual sample? */
478 /* If at least one sample is located before the trigger... */
479 if (trigger_point > 0) {
480 /* Send pre-trigger SR_DF_LOGIC packet to the session bus. */
481 sr_spew("Sending pre-trigger SR_DF_LOGIC packet, "
482 "start = %d, length = %d.", block * BS, trigger_point);
483 packet.type = SR_DF_LOGIC;
484 packet.payload = &logic;
485 logic.length = trigger_point;
487 logic.data = devc->final_buf + (block * BS);
488 sr_session_send(devc->cb_data, &packet);
491 /* Send the SR_DF_TRIGGER packet to the session bus. */
492 sr_spew("Sending SR_DF_TRIGGER packet, sample = %d.",
493 (block * BS) + trigger_point);
494 packet.type = SR_DF_TRIGGER;
495 packet.payload = NULL;
496 sr_session_send(devc->cb_data, &packet);
498 /* If at least one sample is located after the trigger... */
499 if (trigger_point < (BS - 1)) {
500 /* Send post-trigger SR_DF_LOGIC packet to the session bus. */
501 sr_spew("Sending post-trigger SR_DF_LOGIC packet, "
502 "start = %d, length = %d.",
503 (block * BS) + trigger_point, BS - trigger_point);
504 packet.type = SR_DF_LOGIC;
505 packet.payload = &logic;
506 logic.length = BS - trigger_point;
508 logic.data = devc->final_buf + (block * BS) + trigger_point;
509 sr_session_send(devc->cb_data, &packet);