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/>.
21 #include <libserialport.h>
23 extern SR_PRIV struct sr_dev_driver ols_driver_info;
24 static struct sr_dev_driver *di = &ols_driver_info;
26 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
31 sr_dbg("Sending cmd 0x%.2x.", command);
33 if (serial_write_blocking(serial, buf, 1, serial_timeout(serial, 1)) != 1)
36 if (serial_drain(serial) != 0)
42 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
43 uint8_t command, uint8_t *data)
47 sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command,
48 data[0], data[1], data[2], data[3]);
54 if (serial_write_blocking(serial, buf, 5, serial_timeout(serial, 1)) != 5)
57 if (serial_drain(serial) != 0)
63 /* Configures the channel mask based on which channels are enabled. */
64 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
66 struct dev_context *devc;
67 struct sr_channel *channel;
72 devc->channel_mask = 0;
73 for (l = sdi->channels; l; l = l->next) {
76 devc->channel_mask |= 1 << channel->index;
80 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
82 struct dev_context *devc;
83 struct sr_trigger *trigger;
84 struct sr_trigger_stage *stage;
85 struct sr_trigger_match *match;
92 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
93 devc->trigger_mask[i] = 0;
94 devc->trigger_value[i] = 0;
97 if (!(trigger = sr_session_trigger_get(sdi->session)))
100 devc->num_stages = g_slist_length(trigger->stages);
101 if (devc->num_stages > NUM_TRIGGER_STAGES) {
102 sr_err("This device only supports %d trigger stages.",
107 for (l = trigger->stages; l; l = l->next) {
109 for (m = stage->matches; m; m = m->next) {
111 if (!match->channel->enabled)
112 /* Ignore disabled channels with a trigger. */
114 devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
115 if (match->match == SR_TRIGGER_ONE)
116 devc->trigger_value[stage->stage] |= 1 << match->channel->index;
123 SR_PRIV struct dev_context *ols_dev_new(void)
125 struct dev_context *devc;
127 devc = g_malloc0(sizeof(struct dev_context));
129 /* Device-specific settings */
130 devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
132 /* Acquisition settings */
133 devc->limit_samples = devc->capture_ratio = 0;
134 devc->trigger_at = -1;
135 devc->channel_mask = 0xffffffff;
141 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
143 struct sr_dev_inst *sdi;
144 struct dev_context *devc;
145 uint32_t tmp_int, ui;
146 uint8_t key, type, token;
148 GString *tmp_str, *devname, *version;
151 sdi = g_malloc0(sizeof(struct sr_dev_inst));
152 sdi->status = SR_ST_INACTIVE;
154 devc = ols_dev_new();
157 devname = g_string_new("");
158 version = g_string_new("");
162 delay_ms = serial_timeout(serial, 1);
163 if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
166 sr_dbg("Got metadata key 0x00, metadata ends.");
173 /* NULL-terminated string */
174 tmp_str = g_string_new("");
175 delay_ms = serial_timeout(serial, 1);
176 while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
177 g_string_append_c(tmp_str, tmp_c);
178 sr_dbg("Got metadata key 0x%.2x value '%s'.",
183 devname = g_string_append(devname, tmp_str->str);
186 /* FPGA firmware version */
188 g_string_append(version, ", ");
189 g_string_append(version, "FPGA version ");
190 g_string_append(version, tmp_str->str);
193 /* Ancillary version */
195 g_string_append(version, ", ");
196 g_string_append(version, "Ancillary version ");
197 g_string_append(version, tmp_str->str);
200 sr_info("ols: unknown token 0x%.2x: '%s'",
201 token, tmp_str->str);
204 g_string_free(tmp_str, TRUE);
207 /* 32-bit unsigned integer */
208 delay_ms = serial_timeout(serial, 4);
209 if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
211 tmp_int = RB32(&tmp_int);
212 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
216 /* Number of usable channels */
217 for (ui = 0; ui < tmp_int; ui++)
218 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
219 ols_channel_names[ui]);
222 /* Amount of sample memory available (bytes) */
223 devc->max_samples = tmp_int;
226 /* Amount of dynamic memory available (bytes) */
227 /* what is this for? */
230 /* Maximum sample rate (hz) */
231 devc->max_samplerate = tmp_int;
234 /* protocol version */
235 devc->protocol_version = tmp_int;
238 sr_info("Unknown token 0x%.2x: 0x%.8x.",
244 /* 8-bit unsigned integer */
245 delay_ms = serial_timeout(serial, 1);
246 if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
248 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
252 /* Number of usable channels */
253 for (ui = 0; ui < tmp_c; ui++)
254 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
255 ols_channel_names[ui]);
258 /* protocol version */
259 devc->protocol_version = tmp_c;
262 sr_info("Unknown token 0x%.2x: 0x%.2x.",
273 sdi->model = devname->str;
274 sdi->version = version->str;
275 g_string_free(devname, FALSE);
276 g_string_free(version, FALSE);
281 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
282 const uint64_t samplerate)
284 struct dev_context *devc;
287 if (devc->max_samplerate && samplerate > devc->max_samplerate)
288 return SR_ERR_SAMPLERATE;
290 if (samplerate > CLOCK_RATE) {
291 sr_info("Enabling demux mode.");
292 devc->flag_reg |= FLAG_DEMUX;
293 devc->flag_reg &= ~FLAG_FILTER;
294 devc->max_channels = NUM_CHANNELS / 2;
295 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
297 sr_info("Disabling demux mode.");
298 devc->flag_reg &= ~FLAG_DEMUX;
299 devc->flag_reg |= FLAG_FILTER;
300 devc->max_channels = NUM_CHANNELS;
301 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
304 /* Calculate actual samplerate used and complain if it is different
305 * from the requested.
307 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
308 if (devc->flag_reg & FLAG_DEMUX)
309 devc->cur_samplerate *= 2;
310 if (devc->cur_samplerate != samplerate)
311 sr_info("Can't match samplerate %" PRIu64 ", using %"
312 PRIu64 ".", samplerate, devc->cur_samplerate);
317 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
319 struct sr_datafeed_packet packet;
320 struct sr_serial_dev_inst *serial;
323 serial_source_remove(sdi->session, serial);
325 /* Terminate session */
326 packet.type = SR_DF_END;
327 sr_session_send(sdi, &packet);
330 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
332 struct dev_context *devc;
333 struct sr_dev_inst *sdi;
334 struct sr_serial_dev_inst *serial;
335 struct sr_datafeed_packet packet;
336 struct sr_datafeed_logic logic;
338 int num_ols_changrp, offset, j;
348 if (devc->num_transfers++ == 0) {
350 * First time round, means the device started sending data,
351 * and will not stop until done. If it stops sending for
352 * longer than it takes to send a byte, that means it's
353 * finished. We'll double that to 30ms to be sure...
355 serial_source_remove(sdi->session, serial);
356 serial_source_add(sdi->session, serial, G_IO_IN, 30,
357 ols_receive_data, cb_data);
358 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
359 if (!devc->raw_sample_buf) {
360 sr_err("Sample buffer malloc failed.");
363 /* fill with 1010... for debugging */
364 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
368 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
369 if ((devc->flag_reg & i) == 0) {
374 if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
375 if (serial_read_nonblocking(serial, &byte, 1) != 1)
379 /* Ignore it if we've read enough. */
380 if (devc->num_samples >= devc->limit_samples)
383 devc->sample[devc->num_bytes++] = byte;
384 sr_spew("Received byte 0x%.2x.", byte);
385 if (devc->num_bytes == num_ols_changrp) {
387 devc->cnt_samples_rle++;
389 * Got a full sample. Convert from the OLS's little-endian
390 * sample to the local format.
392 sample = devc->sample[0] | (devc->sample[1] << 8) \
393 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
394 sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
395 if (devc->flag_reg & FLAG_RLE) {
397 * In RLE mode the high bit of the sample is the
398 * "count" flag, meaning this sample is the number
399 * of times the previous sample occurred.
401 if (devc->sample[devc->num_bytes - 1] & 0x80) {
402 /* Clear the high bit. */
403 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
404 devc->rle_count = sample;
405 devc->cnt_samples_rle += devc->rle_count;
406 sr_dbg("RLE count: %u.", devc->rle_count);
411 devc->num_samples += devc->rle_count + 1;
412 if (devc->num_samples > devc->limit_samples) {
413 /* Save us from overrunning the buffer. */
414 devc->rle_count -= devc->num_samples - devc->limit_samples;
415 devc->num_samples = devc->limit_samples;
418 if (num_ols_changrp < 4) {
420 * Some channel groups may have been turned
421 * off, to speed up transfer between the
422 * hardware and the PC. Expand that here before
423 * submitting it over the session bus --
424 * whatever is listening on the bus will be
425 * expecting a full 32-bit sample, based on
426 * the number of channels.
429 memset(devc->tmp_sample, 0, 4);
430 for (i = 0; i < 4; i++) {
431 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
433 * This channel group was
434 * enabled, copy from received
437 devc->tmp_sample[i] = devc->sample[j++];
438 } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
439 /* group 2 & 3 get added to 0 & 1 */
440 devc->tmp_sample[i - 2] = devc->sample[j++];
443 memcpy(devc->sample, devc->tmp_sample, 4);
444 sr_spew("Expanded sample: 0x%.8x.", sample);
448 * the OLS sends its sample buffer backwards.
449 * store it in reverse order here, so we can dump
450 * this on the session bus later.
452 offset = (devc->limit_samples - devc->num_samples) * 4;
453 for (i = 0; i <= devc->rle_count; i++) {
454 memcpy(devc->raw_sample_buf + offset + (i * 4),
457 memset(devc->sample, 0, 4);
463 * This is the main loop telling us a timeout was reached, or
464 * we've acquired all the samples we asked for -- we're done.
465 * Send the (properly-ordered) buffer to the frontend.
467 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
468 devc->cnt_bytes, devc->cnt_samples,
469 devc->cnt_samples_rle);
470 if (devc->trigger_at != -1) {
472 * A trigger was set up, so we need to tell the frontend
475 if (devc->trigger_at > 0) {
476 /* There are pre-trigger samples, send those first. */
477 packet.type = SR_DF_LOGIC;
478 packet.payload = &logic;
479 logic.length = devc->trigger_at * 4;
481 logic.data = devc->raw_sample_buf +
482 (devc->limit_samples - devc->num_samples) * 4;
483 sr_session_send(cb_data, &packet);
486 /* Send the trigger. */
487 packet.type = SR_DF_TRIGGER;
488 sr_session_send(cb_data, &packet);
490 /* Send post-trigger samples. */
491 packet.type = SR_DF_LOGIC;
492 packet.payload = &logic;
493 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
495 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
496 (devc->limit_samples - devc->num_samples) * 4;
497 sr_session_send(cb_data, &packet);
499 /* no trigger was used */
500 packet.type = SR_DF_LOGIC;
501 packet.payload = &logic;
502 logic.length = devc->num_samples * 4;
504 logic.data = devc->raw_sample_buf +
505 (devc->limit_samples - devc->num_samples) * 4;
506 sr_session_send(cb_data, &packet);
508 g_free(devc->raw_sample_buf);
510 serial_flush(serial);
511 abort_acquisition(sdi);