2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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 3 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 extern SR_PRIV struct sr_dev_driver p_ols_driver_info;
25 SR_PRIV int write_shortcommand(struct dev_context *devc, uint8_t command)
30 sr_dbg("Sending cmd 0x%.2x.", command);
32 bytes_written = ftdi_write_data(devc->ftdic, buf, 1);
33 if (bytes_written < 0) {
34 sr_err("Failed to write FTDI data (%d): %s.",
35 bytes_written, ftdi_get_error_string(devc->ftdic));
37 } else if (bytes_written != 1) {
38 sr_err("FTDI write error, only %d/%d bytes written: %s.",
39 bytes_written, 1, ftdi_get_error_string(devc->ftdic));
46 SR_PRIV int write_longcommand(struct dev_context *devc, uint8_t command, uint8_t *data)
51 sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command,
52 data[0], data[1], data[2], data[3]);
58 bytes_written = ftdi_write_data(devc->ftdic, buf, 5);
59 if (bytes_written < 0) {
60 sr_err("Failed to write FTDI data (%d): %s.",
61 bytes_written, ftdi_get_error_string(devc->ftdic));
63 } else if (bytes_written != 5) {
64 sr_err("FTDI write error, only %d/%d bytes written: %s.",
65 bytes_written, 1, ftdi_get_error_string(devc->ftdic));
72 SR_PRIV int p_ols_open(struct dev_context *devc)
76 /* Note: Caller checks devc and devc->ftdic. */
78 /* Select interface B, otherwise communication will fail. */
79 ret = ftdi_set_interface(devc->ftdic, INTERFACE_B);
81 sr_err("Failed to set FTDI interface B (%d): %s", ret,
82 ftdi_get_error_string(devc->ftdic));
85 sr_dbg("FTDI chip interface B set successfully.");
87 /* Check for the device and temporarily open it. */
88 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
91 /* Log errors, except for -3 ("device not found"). */
93 sr_err("Failed to open device (%d): %s", ret,
94 ftdi_get_error_string(devc->ftdic));
97 sr_dbg("FTDI device opened successfully.");
99 /* Purge RX/TX buffers in the FTDI chip. */
100 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
101 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
102 ret, ftdi_get_error_string(devc->ftdic));
103 goto err_open_close_ftdic;
105 sr_dbg("FTDI chip buffers purged successfully.");
107 /* Reset the FTDI bitmode. */
108 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
110 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
111 ret, ftdi_get_error_string(devc->ftdic));
112 goto err_open_close_ftdic;
114 sr_dbg("FTDI chip bitmode reset successfully.");
116 /* Set the FTDI latency timer to 16. */
117 ret = ftdi_set_latency_timer(devc->ftdic, 16);
119 sr_err("Failed to set FTDI latency timer (%d): %s.",
120 ret, ftdi_get_error_string(devc->ftdic));
121 goto err_open_close_ftdic;
123 sr_dbg("FTDI chip latency timer set successfully.");
125 /* Set the FTDI read data chunk size to 64kB. */
126 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
128 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
129 ret, ftdi_get_error_string(devc->ftdic));
130 goto err_open_close_ftdic;
132 sr_dbg("FTDI chip read data chunk size set successfully.");
136 err_open_close_ftdic:
137 ftdi_usb_close(devc->ftdic);
141 SR_PRIV int p_ols_close(struct dev_context *devc)
145 /* Note: Caller checks devc and devc->ftdic. */
147 if ((ret = ftdi_usb_close(devc->ftdic)) < 0) {
148 sr_err("Failed to close FTDI device (%d): %s.",
149 ret, ftdi_get_error_string(devc->ftdic));
156 /* Configures the channel mask based on which channels are enabled. */
157 SR_PRIV void pols_channel_mask(const struct sr_dev_inst *sdi)
159 struct dev_context *devc;
160 struct sr_channel *channel;
165 devc->channel_mask = 0;
166 for (l = sdi->channels; l; l = l->next) {
168 if (channel->enabled)
169 devc->channel_mask |= 1 << channel->index;
173 SR_PRIV int pols_convert_trigger(const struct sr_dev_inst *sdi)
175 struct dev_context *devc;
176 struct sr_trigger *trigger;
177 struct sr_trigger_stage *stage;
178 struct sr_trigger_match *match;
184 devc->num_stages = 0;
185 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
186 devc->trigger_mask[i] = 0;
187 devc->trigger_value[i] = 0;
188 devc->trigger_edge[i] = 0;
191 if (!(trigger = sr_session_trigger_get(sdi->session)))
194 devc->num_stages = g_slist_length(trigger->stages);
195 if (devc->num_stages > NUM_TRIGGER_STAGES) {
196 sr_err("This device only supports %d trigger stages.",
201 for (l = trigger->stages; l; l = l->next) {
203 for (m = stage->matches; m; m = m->next) {
205 if (!match->channel->enabled)
206 /* Ignore disabled channels with a trigger. */
208 devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
209 if (match->match == SR_TRIGGER_ONE || match->match == SR_TRIGGER_RISING)
210 devc->trigger_value[stage->stage] |= 1 << match->channel->index;
211 if (match->match == SR_TRIGGER_RISING || match->match == SR_TRIGGER_FALLING)
212 devc->trigger_edge[stage->stage] |= 1 << match->channel->index;
219 SR_PRIV struct sr_dev_inst *p_ols_get_metadata(uint8_t *buf, int bytes_read, struct dev_context *devc)
221 struct sr_dev_inst *sdi;
222 uint32_t tmp_int, ui;
223 uint8_t key, type, token;
224 GString *tmp_str, *devname, *version;
228 sdi = g_malloc0(sizeof(struct sr_dev_inst));
229 sdi->status = SR_ST_INACTIVE;
230 sdi->driver = &p_ols_driver_info;
233 devname = g_string_new("");
234 version = g_string_new("");
237 while (index < bytes_read) {
240 sr_dbg("Got metadata key 0x00, metadata ends.");
247 /* NULL-terminated string */
248 tmp_str = g_string_new("");
249 while ((index < bytes_read) && ((tmp_c = buf[index++]) != '\0'))
250 g_string_append_c(tmp_str, tmp_c);
251 sr_dbg("Got metadata key 0x%.2x value '%s'.",
256 devname = g_string_append(devname, tmp_str->str);
259 /* FPGA firmware version */
261 g_string_append(version, ", ");
262 g_string_append(version, "FPGA version ");
263 g_string_append(version, tmp_str->str);
266 /* Ancillary version */
268 g_string_append(version, ", ");
269 g_string_append(version, "Ancillary version ");
270 g_string_append(version, tmp_str->str);
273 sr_info("Unknown token 0x%.2x: '%s'",
274 token, tmp_str->str);
277 g_string_free(tmp_str, TRUE);
280 /* 32-bit unsigned integer */
282 for (i = 0; i < 4; i++) {
283 tmp_int = (tmp_int << 8) | buf[index++];
285 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
289 /* Number of usable channels */
290 for (ui = 0; ui < tmp_int; ui++)
291 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
292 p_ols_channel_names[ui]);
295 /* Amount of sample memory available (bytes) */
296 devc->max_samplebytes = tmp_int;
299 /* Amount of dynamic memory available (bytes) */
300 /* what is this for? */
303 /* Maximum sample rate (Hz) */
304 devc->max_samplerate = tmp_int;
307 /* protocol version */
308 devc->protocol_version = tmp_int;
311 sr_info("Unknown token 0x%.2x: 0x%.8x.",
317 /* 8-bit unsigned integer */
318 tmp_c = buf[index++];
319 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
323 /* Number of usable channels */
324 for (ui = 0; ui < tmp_c; ui++)
325 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
326 p_ols_channel_names[ui]);
329 /* protocol version */
330 devc->protocol_version = tmp_c;
333 sr_info("Unknown token 0x%.2x: 0x%.2x.",
344 sdi->model = devname->str;
345 sdi->version = version->str;
346 g_string_free(devname, FALSE);
347 g_string_free(version, FALSE);
352 SR_PRIV int p_ols_set_samplerate(const struct sr_dev_inst *sdi,
353 const uint64_t samplerate)
355 struct dev_context *devc;
358 if (devc->max_samplerate && samplerate > devc->max_samplerate)
359 return SR_ERR_SAMPLERATE;
361 if (samplerate > CLOCK_RATE) {
362 sr_info("Enabling demux mode.");
363 devc->flag_reg |= FLAG_DEMUX;
364 devc->flag_reg &= ~FLAG_FILTER;
365 devc->max_channels = NUM_CHANNELS / 2;
366 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
368 sr_info("Disabling demux mode.");
369 devc->flag_reg &= ~FLAG_DEMUX;
370 devc->flag_reg |= FLAG_FILTER;
371 devc->max_channels = NUM_CHANNELS;
372 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
375 /* Calculate actual samplerate used and complain if it is different
376 * from the requested.
378 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
379 if (devc->flag_reg & FLAG_DEMUX)
380 devc->cur_samplerate *= 2;
381 if (devc->cur_samplerate != samplerate)
382 sr_info("Can't match samplerate %" PRIu64 ", using %"
383 PRIu64 ".", samplerate, devc->cur_samplerate);
388 SR_PRIV int p_ols_receive_data(int fd, int revents, void *cb_data)
390 struct dev_context *devc;
391 struct sr_dev_inst *sdi;
392 struct sr_datafeed_packet packet;
393 struct sr_datafeed_logic logic;
395 int num_channels, offset, j;
396 int bytes_read, index;
406 if (devc->num_transfers++ == 0) {
407 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
408 if (!devc->raw_sample_buf) {
409 sr_err("Sample buffer malloc failed.");
412 /* fill with 1010... for debugging */
413 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
416 if ((devc->num_samples < devc->limit_samples) && (devc->cnt_samples < devc->max_samples)) {
419 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
420 if ((devc->flag_reg & i) == 0) {
425 /* Get a block of data. */
426 bytes_read = ftdi_read_data(devc->ftdic, devc->ftdi_buf, FTDI_BUF_SIZE);
427 if (bytes_read < 0) {
428 sr_err("Failed to read FTDI data (%d): %s.",
429 bytes_read, ftdi_get_error_string(devc->ftdic));
430 sdi->driver->dev_acquisition_stop(sdi, sdi);
433 if (bytes_read == 0) {
434 sr_spew("Received 0 bytes, nothing to do.");
438 sr_dbg("Received %d bytes", bytes_read);
441 while (index < bytes_read) {
442 byte = devc->ftdi_buf[index++];
445 devc->sample[devc->num_bytes++] = byte;
446 sr_spew("Received byte 0x%.2x.", byte);
448 if ((devc->flag_reg & FLAG_DEMUX) && (devc->flag_reg & FLAG_RLE)) {
449 /* RLE in demux mode must be processed differently
450 * since in this case the RLE encoder is operating on pairs of samples.
452 if (devc->num_bytes == num_channels * 2) {
453 devc->cnt_samples += 2;
454 devc->cnt_samples_rle += 2;
456 * Got a sample pair. Convert from the OLS's little-endian
457 * sample to the local format.
459 sample = devc->sample[0] | (devc->sample[1] << 8) \
460 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
461 sr_spew("Received sample pair 0x%.*x.", devc->num_bytes * 2, sample);
464 * In RLE mode the high bit of the sample pair is the
465 * "count" flag, meaning this sample pair is the number
466 * of times the previous sample pair occurred.
468 if (devc->sample[devc->num_bytes - 1] & 0x80) {
469 /* Clear the high bit. */
470 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
471 devc->rle_count = sample;
472 devc->cnt_samples_rle += devc->rle_count * 2;
473 sr_dbg("RLE count: %u.", devc->rle_count * 2);
477 devc->num_samples += (devc->rle_count + 1) * 2;
478 if (devc->num_samples > devc->limit_samples) {
479 /* Save us from overrunning the buffer. */
480 devc->rle_count -= (devc->num_samples - devc->limit_samples) / 2;
481 devc->num_samples = devc->limit_samples;
486 * Some channel groups may have been turned
487 * off, to speed up transfer between the
488 * hardware and the PC. Expand that here before
489 * submitting it over the session bus --
490 * whatever is listening on the bus will be
491 * expecting a full 32-bit sample, based on
492 * the number of channels.
495 /* expand first sample */
496 memset(devc->tmp_sample, 0, 4);
497 for (i = 0; i < 2; i++) {
498 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
500 * This channel group was
501 * enabled, copy from received
504 devc->tmp_sample[i] = devc->sample[j++];
507 /* Clear out the most significant bit of the sample */
508 devc->tmp_sample[devc->num_bytes - 1] &= 0x7f;
509 sr_spew("Expanded sample 1: 0x%.2x%.2x%.2x%.2x.",
510 devc->tmp_sample[3], devc->tmp_sample[2],
511 devc->tmp_sample[1], devc->tmp_sample[0]);
513 /* expand second sample */
514 memset(devc->tmp_sample2, 0, 4);
515 for (i = 0; i < 2; i++) {
516 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
518 * This channel group was
519 * enabled, copy from received
522 devc->tmp_sample2[i] = devc->sample[j++];
525 /* Clear out the most significant bit of the sample */
526 devc->tmp_sample2[devc->num_bytes - 1] &= 0x7f;
527 sr_spew("Expanded sample 2: 0x%.2x%.2x%.2x%.2x.",
528 devc->tmp_sample2[3], devc->tmp_sample2[2],
529 devc->tmp_sample2[1], devc->tmp_sample2[0]);
532 * OLS sends its sample buffer backwards.
533 * store it in reverse order here, so we can dump
534 * this on the session bus later.
536 offset = (devc->limit_samples - devc->num_samples) * 4;
537 for (i = 0; i <= devc->rle_count; i++) {
538 memcpy(devc->raw_sample_buf + offset + (i * 8),
539 devc->tmp_sample2, 4);
540 memcpy(devc->raw_sample_buf + offset + (4 + (i * 8)),
541 devc->tmp_sample, 4);
543 memset(devc->sample, 0, 4);
549 if (devc->num_bytes == num_channels) {
551 devc->cnt_samples_rle++;
553 * Got a full sample. Convert from the OLS's little-endian
554 * sample to the local format.
556 sample = devc->sample[0] | (devc->sample[1] << 8) \
557 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
558 sr_spew("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
559 if (devc->flag_reg & FLAG_RLE) {
561 * In RLE mode the high bit of the sample is the
562 * "count" flag, meaning this sample is the number
563 * of times the previous sample occurred.
565 if (devc->sample[devc->num_bytes - 1] & 0x80) {
566 /* Clear the high bit. */
567 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
568 devc->rle_count = sample;
569 devc->cnt_samples_rle += devc->rle_count;
570 sr_dbg("RLE count: %u.", devc->rle_count);
575 devc->num_samples += devc->rle_count + 1;
576 if (devc->num_samples > devc->limit_samples) {
577 /* Save us from overrunning the buffer. */
578 devc->rle_count -= devc->num_samples - devc->limit_samples;
579 devc->num_samples = devc->limit_samples;
583 if (num_channels < 4) {
585 * Some channel groups may have been turned
586 * off, to speed up transfer between the
587 * hardware and the PC. Expand that here before
588 * submitting it over the session bus --
589 * whatever is listening on the bus will be
590 * expecting a full 32-bit sample, based on
591 * the number of channels.
594 memset(devc->tmp_sample, 0, 4);
595 for (i = 0; i < 4; i++) {
596 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
598 * This channel group was
599 * enabled, copy from received
602 devc->tmp_sample[i] = devc->sample[j++];
605 memcpy(devc->sample, devc->tmp_sample, 4);
606 sr_spew("Expanded sample: 0x%.8x.", sample);
610 * Pipistrello OLS sends its sample buffer backwards.
611 * store it in reverse order here, so we can dump
612 * this on the session bus later.
614 offset = (devc->limit_samples - devc->num_samples) * 4;
615 for (i = 0; i <= devc->rle_count; i++) {
616 memcpy(devc->raw_sample_buf + offset + (i * 4),
619 memset(devc->sample, 0, 4);
628 bytes_read = ftdi_read_data(devc->ftdic, devc->ftdi_buf, FTDI_BUF_SIZE);
629 } while (bytes_read > 0);
632 * We've acquired all the samples we asked for -- we're done.
633 * Send the (properly-ordered) buffer to the frontend.
635 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
636 devc->cnt_bytes, devc->cnt_samples,
637 devc->cnt_samples_rle);
638 if (devc->trigger_at != -1) {
640 * A trigger was set up, so we need to tell the frontend
643 if (devc->trigger_at > 0) {
644 /* There are pre-trigger samples, send those first. */
645 packet.type = SR_DF_LOGIC;
646 packet.payload = &logic;
647 logic.length = devc->trigger_at * 4;
649 logic.data = devc->raw_sample_buf +
650 (devc->limit_samples - devc->num_samples) * 4;
651 sr_session_send(cb_data, &packet);
654 /* Send the trigger. */
655 packet.type = SR_DF_TRIGGER;
656 sr_session_send(cb_data, &packet);
658 /* Send post-trigger samples. */
659 packet.type = SR_DF_LOGIC;
660 packet.payload = &logic;
661 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
663 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
664 (devc->limit_samples - devc->num_samples) * 4;
665 sr_session_send(cb_data, &packet);
667 /* no trigger was used */
668 packet.type = SR_DF_LOGIC;
669 packet.payload = &logic;
670 logic.length = devc->num_samples * 4;
672 logic.data = devc->raw_sample_buf +
673 (devc->limit_samples - devc->num_samples) * 4;
674 sr_session_send(cb_data, &packet);
676 g_free(devc->raw_sample_buf);
678 sdi->driver->dev_acquisition_stop(sdi, cb_data);