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 SR_PRIV int write_shortcommand(struct dev_context *devc, uint8_t command)
28 sr_dbg("Sending cmd 0x%.2x.", command);
30 bytes_written = ftdi_write_data(devc->ftdic, buf, 1);
31 if (bytes_written < 0) {
32 sr_err("Failed to write FTDI data (%d): %s.",
33 bytes_written, ftdi_get_error_string(devc->ftdic));
35 } else if (bytes_written != 1) {
36 sr_err("FTDI write error, only %d/%d bytes written: %s.",
37 bytes_written, 1, ftdi_get_error_string(devc->ftdic));
44 SR_PRIV int write_longcommand(struct dev_context *devc, uint8_t command, uint8_t *data)
49 sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command,
50 data[0], data[1], data[2], data[3]);
56 bytes_written = ftdi_write_data(devc->ftdic, buf, 5);
57 if (bytes_written < 0) {
58 sr_err("Failed to write FTDI data (%d): %s.",
59 bytes_written, ftdi_get_error_string(devc->ftdic));
61 } else if (bytes_written != 5) {
62 sr_err("FTDI write error, only %d/%d bytes written: %s.",
63 bytes_written, 1, ftdi_get_error_string(devc->ftdic));
70 SR_PRIV int p_ols_open(struct dev_context *devc)
74 /* Note: Caller checks devc and devc->ftdic. */
76 ret = ftdi_set_interface(devc->ftdic, INTERFACE_B);
78 sr_err("Failed to set FTDI interface B (%d): %s", ret,
79 ftdi_get_error_string(devc->ftdic));
83 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
86 /* Log errors, except for -3 ("device not found"). */
88 sr_err("Failed to open device (%d): %s", ret,
89 ftdi_get_error_string(devc->ftdic));
93 if ((ret = PURGE_FTDI_BOTH(devc->ftdic)) < 0) {
94 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
95 ret, ftdi_get_error_string(devc->ftdic));
96 goto err_open_close_ftdic;
99 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
101 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
102 ret, ftdi_get_error_string(devc->ftdic));
103 goto err_open_close_ftdic;
106 ret = ftdi_set_latency_timer(devc->ftdic, 16);
108 sr_err("Failed to set FTDI latency timer (%d): %s.",
109 ret, ftdi_get_error_string(devc->ftdic));
110 goto err_open_close_ftdic;
113 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
115 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
116 ret, ftdi_get_error_string(devc->ftdic));
117 goto err_open_close_ftdic;
122 err_open_close_ftdic:
123 ftdi_usb_close(devc->ftdic);
128 SR_PRIV int p_ols_close(struct dev_context *devc)
132 /* Note: Caller checks devc and devc->ftdic. */
134 if ((ret = ftdi_usb_close(devc->ftdic)) < 0) {
135 sr_err("Failed to close FTDI device (%d): %s.",
136 ret, ftdi_get_error_string(devc->ftdic));
143 /* Configures the channel mask based on which channels are enabled. */
144 SR_PRIV void pols_channel_mask(const struct sr_dev_inst *sdi)
146 struct dev_context *devc;
147 struct sr_channel *channel;
152 devc->channel_mask = 0;
153 for (l = sdi->channels; l; l = l->next) {
155 if (channel->enabled)
156 devc->channel_mask |= 1 << channel->index;
160 SR_PRIV int pols_convert_trigger(const struct sr_dev_inst *sdi)
162 struct dev_context *devc;
163 struct sr_trigger *trigger;
164 struct sr_trigger_stage *stage;
165 struct sr_trigger_match *match;
171 devc->num_stages = 0;
172 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
173 devc->trigger_mask[i] = 0;
174 devc->trigger_value[i] = 0;
175 devc->trigger_edge[i] = 0;
178 if (!(trigger = sr_session_trigger_get(sdi->session)))
181 devc->num_stages = g_slist_length(trigger->stages);
182 if (devc->num_stages > NUM_TRIGGER_STAGES) {
183 sr_err("This device only supports %d trigger stages.",
188 for (l = trigger->stages; l; l = l->next) {
190 for (m = stage->matches; m; m = m->next) {
192 if (!match->channel->enabled)
193 /* Ignore disabled channels with a trigger. */
195 devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
196 if (match->match == SR_TRIGGER_ONE || match->match == SR_TRIGGER_RISING)
197 devc->trigger_value[stage->stage] |= 1 << match->channel->index;
198 if (match->match == SR_TRIGGER_RISING || match->match == SR_TRIGGER_FALLING)
199 devc->trigger_edge[stage->stage] |= 1 << match->channel->index;
206 SR_PRIV struct sr_dev_inst *p_ols_get_metadata(uint8_t *buf, int bytes_read, struct dev_context *devc)
208 struct sr_dev_inst *sdi;
209 uint32_t tmp_int, ui;
210 uint8_t key, type, token;
211 GString *tmp_str, *devname, *version;
215 sdi = g_malloc0(sizeof(struct sr_dev_inst));
216 sdi->status = SR_ST_INACTIVE;
219 devname = g_string_new("");
220 version = g_string_new("");
223 while (index < bytes_read) {
226 sr_dbg("Got metadata key 0x00, metadata ends.");
233 /* NULL-terminated string */
234 tmp_str = g_string_new("");
235 while ((index < bytes_read) && ((tmp_c = buf[index++]) != '\0'))
236 g_string_append_c(tmp_str, tmp_c);
237 sr_dbg("Got metadata key 0x%.2x value '%s'.",
242 devname = g_string_append(devname, tmp_str->str);
245 /* FPGA firmware version */
247 g_string_append(version, ", ");
248 g_string_append(version, "FPGA version ");
249 g_string_append(version, tmp_str->str);
252 /* Ancillary version */
254 g_string_append(version, ", ");
255 g_string_append(version, "Ancillary version ");
256 g_string_append(version, tmp_str->str);
259 sr_info("Unknown token 0x%.2x: '%s'",
260 token, tmp_str->str);
263 g_string_free(tmp_str, TRUE);
266 /* 32-bit unsigned integer */
267 tmp_int = RB32(&buf[index]);
268 index += sizeof(uint32_t);
269 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
273 /* Number of usable channels */
274 for (ui = 0; ui < tmp_int; ui++)
275 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
276 p_ols_channel_names[ui]);
279 /* Amount of sample memory available (bytes) */
280 devc->max_samplebytes = tmp_int;
283 /* Amount of dynamic memory available (bytes) */
284 /* what is this for? */
287 /* Maximum sample rate (Hz) */
288 devc->max_samplerate = tmp_int;
291 /* protocol version */
292 devc->protocol_version = tmp_int;
295 sr_info("Unknown token 0x%.2x: 0x%.8x.",
301 /* 8-bit unsigned integer */
302 tmp_c = buf[index++];
303 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
307 /* Number of usable channels */
308 for (ui = 0; ui < tmp_c; ui++)
309 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
310 p_ols_channel_names[ui]);
313 /* protocol version */
314 devc->protocol_version = tmp_c;
317 sr_info("Unknown token 0x%.2x: 0x%.2x.",
328 sdi->model = g_string_free(devname, FALSE);
329 sdi->version = g_string_free(version, FALSE);
334 SR_PRIV int p_ols_set_samplerate(const struct sr_dev_inst *sdi,
335 const uint64_t samplerate)
337 struct dev_context *devc;
340 if (devc->max_samplerate && samplerate > devc->max_samplerate)
341 return SR_ERR_SAMPLERATE;
343 if (samplerate > CLOCK_RATE) {
344 sr_info("Enabling demux mode.");
345 devc->flag_reg |= FLAG_DEMUX;
346 devc->flag_reg &= ~FLAG_FILTER;
347 devc->max_channels = NUM_CHANNELS / 2;
348 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
350 sr_info("Disabling demux mode.");
351 devc->flag_reg &= ~FLAG_DEMUX;
352 devc->flag_reg |= FLAG_FILTER;
353 devc->max_channels = NUM_CHANNELS;
354 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
357 /* Calculate actual samplerate used and complain if it is different
358 * from the requested.
360 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
361 if (devc->flag_reg & FLAG_DEMUX)
362 devc->cur_samplerate *= 2;
363 if (devc->cur_samplerate != samplerate)
364 sr_info("Can't match samplerate %" PRIu64 ", using %"
365 PRIu64 ".", samplerate, devc->cur_samplerate);
370 SR_PRIV int p_ols_receive_data(int fd, int revents, void *cb_data)
372 struct dev_context *devc;
373 struct sr_dev_inst *sdi;
374 struct sr_datafeed_packet packet;
375 struct sr_datafeed_logic logic;
377 int num_channels, offset, j;
378 int bytes_read, index;
388 if (devc->num_transfers++ == 0) {
389 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
390 if (!devc->raw_sample_buf) {
391 sr_err("Sample buffer malloc failed.");
394 /* fill with 1010... for debugging */
395 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
398 if ((devc->num_samples < devc->limit_samples) && (devc->cnt_samples < devc->max_samples)) {
401 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
402 if ((devc->flag_reg & i) == 0) {
407 /* Get a block of data. */
408 bytes_read = ftdi_read_data(devc->ftdic, devc->ftdi_buf, FTDI_BUF_SIZE);
409 if (bytes_read < 0) {
410 sr_err("Failed to read FTDI data (%d): %s.",
411 bytes_read, ftdi_get_error_string(devc->ftdic));
412 sr_dev_acquisition_stop(sdi);
415 if (bytes_read == 0) {
416 sr_spew("Received 0 bytes, nothing to do.");
420 sr_dbg("Received %d bytes", bytes_read);
423 while (index < bytes_read) {
424 byte = devc->ftdi_buf[index++];
427 devc->sample[devc->num_bytes++] = byte;
428 sr_spew("Received byte 0x%.2x.", byte);
430 if ((devc->flag_reg & FLAG_DEMUX) && (devc->flag_reg & FLAG_RLE)) {
431 /* RLE in demux mode must be processed differently
432 * since in this case the RLE encoder is operating on pairs of samples.
434 if (devc->num_bytes == num_channels * 2) {
435 devc->cnt_samples += 2;
436 devc->cnt_samples_rle += 2;
438 * Got a sample pair. Convert from the OLS's little-endian
439 * sample to the local format.
441 sample = devc->sample[0] | (devc->sample[1] << 8) \
442 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
443 sr_spew("Received sample pair 0x%.*x.", devc->num_bytes * 2, sample);
446 * In RLE mode the high bit of the sample pair is the
447 * "count" flag, meaning this sample pair is the number
448 * of times the previous sample pair occurred.
450 if (devc->sample[devc->num_bytes - 1] & 0x80) {
451 /* Clear the high bit. */
452 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
453 devc->rle_count = sample;
454 devc->cnt_samples_rle += devc->rle_count * 2;
455 sr_dbg("RLE count: %u.", devc->rle_count * 2);
459 devc->num_samples += (devc->rle_count + 1) * 2;
460 if (devc->num_samples > devc->limit_samples) {
461 /* Save us from overrunning the buffer. */
462 devc->rle_count -= (devc->num_samples - devc->limit_samples) / 2;
463 devc->num_samples = devc->limit_samples;
468 * Some channel groups may have been turned
469 * off, to speed up transfer between the
470 * hardware and the PC. Expand that here before
471 * submitting it over the session bus --
472 * whatever is listening on the bus will be
473 * expecting a full 32-bit sample, based on
474 * the number of channels.
477 /* expand first sample */
478 memset(devc->tmp_sample, 0, 4);
479 for (i = 0; i < 2; i++) {
480 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
482 * This channel group was
483 * enabled, copy from received
486 devc->tmp_sample[i] = devc->sample[j++];
489 /* Clear out the most significant bit of the sample */
490 devc->tmp_sample[devc->num_bytes - 1] &= 0x7f;
491 sr_spew("Expanded sample 1: 0x%.2x%.2x%.2x%.2x.",
492 devc->tmp_sample[3], devc->tmp_sample[2],
493 devc->tmp_sample[1], devc->tmp_sample[0]);
495 /* expand second sample */
496 memset(devc->tmp_sample2, 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_sample2[i] = devc->sample[j++];
507 /* Clear out the most significant bit of the sample */
508 devc->tmp_sample2[devc->num_bytes - 1] &= 0x7f;
509 sr_spew("Expanded sample 2: 0x%.2x%.2x%.2x%.2x.",
510 devc->tmp_sample2[3], devc->tmp_sample2[2],
511 devc->tmp_sample2[1], devc->tmp_sample2[0]);
514 * OLS sends its sample buffer backwards.
515 * store it in reverse order here, so we can dump
516 * this on the session bus later.
518 offset = (devc->limit_samples - devc->num_samples) * 4;
519 for (i = 0; i <= devc->rle_count; i++) {
520 memcpy(devc->raw_sample_buf + offset + (i * 8),
521 devc->tmp_sample2, 4);
522 memcpy(devc->raw_sample_buf + offset + (4 + (i * 8)),
523 devc->tmp_sample, 4);
525 memset(devc->sample, 0, 4);
531 if (devc->num_bytes == num_channels) {
533 devc->cnt_samples_rle++;
535 * Got a full sample. Convert from the OLS's little-endian
536 * sample to the local format.
538 sample = devc->sample[0] | (devc->sample[1] << 8) \
539 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
540 sr_spew("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
541 if (devc->flag_reg & FLAG_RLE) {
543 * In RLE mode the high bit of the sample is the
544 * "count" flag, meaning this sample is the number
545 * of times the previous sample occurred.
547 if (devc->sample[devc->num_bytes - 1] & 0x80) {
548 /* Clear the high bit. */
549 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
550 devc->rle_count = sample;
551 devc->cnt_samples_rle += devc->rle_count;
552 sr_dbg("RLE count: %u.", devc->rle_count);
557 devc->num_samples += devc->rle_count + 1;
558 if (devc->num_samples > devc->limit_samples) {
559 /* Save us from overrunning the buffer. */
560 devc->rle_count -= devc->num_samples - devc->limit_samples;
561 devc->num_samples = devc->limit_samples;
565 if (num_channels < 4) {
567 * Some channel groups may have been turned
568 * off, to speed up transfer between the
569 * hardware and the PC. Expand that here before
570 * submitting it over the session bus --
571 * whatever is listening on the bus will be
572 * expecting a full 32-bit sample, based on
573 * the number of channels.
576 memset(devc->tmp_sample, 0, 4);
577 for (i = 0; i < 4; i++) {
578 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
580 * This channel group was
581 * enabled, copy from received
584 devc->tmp_sample[i] = devc->sample[j++];
587 memcpy(devc->sample, devc->tmp_sample, 4);
588 sr_spew("Expanded sample: 0x%.8x.", sample);
592 * Pipistrello OLS sends its sample buffer backwards.
593 * store it in reverse order here, so we can dump
594 * this on the session bus later.
596 offset = (devc->limit_samples - devc->num_samples) * 4;
597 for (i = 0; i <= devc->rle_count; i++) {
598 memcpy(devc->raw_sample_buf + offset + (i * 4),
601 memset(devc->sample, 0, 4);
610 bytes_read = ftdi_read_data(devc->ftdic, devc->ftdi_buf, FTDI_BUF_SIZE);
611 } while (bytes_read > 0);
614 * We've acquired all the samples we asked for -- we're done.
615 * Send the (properly-ordered) buffer to the frontend.
617 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
618 devc->cnt_bytes, devc->cnt_samples,
619 devc->cnt_samples_rle);
620 if (devc->trigger_at != -1) {
622 * A trigger was set up, so we need to tell the frontend
625 if (devc->trigger_at > 0) {
626 /* There are pre-trigger samples, send those first. */
627 packet.type = SR_DF_LOGIC;
628 packet.payload = &logic;
629 logic.length = devc->trigger_at * 4;
631 logic.data = devc->raw_sample_buf +
632 (devc->limit_samples - devc->num_samples) * 4;
633 sr_session_send(sdi, &packet);
636 /* Send the trigger. */
637 std_session_send_df_trigger(sdi);
639 /* Send post-trigger samples. */
640 packet.type = SR_DF_LOGIC;
641 packet.payload = &logic;
642 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
644 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
645 (devc->limit_samples - devc->num_samples) * 4;
646 sr_session_send(sdi, &packet);
648 /* no trigger was used */
649 packet.type = SR_DF_LOGIC;
650 packet.payload = &logic;
651 logic.length = devc->num_samples * 4;
653 logic.data = devc->raw_sample_buf +
654 (devc->limit_samples - devc->num_samples) * 4;
655 sr_session_send(sdi, &packet);
657 g_free(devc->raw_sample_buf);
659 sr_dev_acquisition_stop(sdi);