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 ols_driver_info;
25 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
30 sr_dbg("Sending cmd 0x%.2x.", command);
32 if (serial_write_blocking(serial, buf, 1, serial_timeout(serial, 1)) != 1)
35 if (serial_drain(serial) != 0)
41 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
42 uint8_t command, uint8_t *data)
46 sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command,
47 data[0], data[1], data[2], data[3]);
53 if (serial_write_blocking(serial, buf, 5, serial_timeout(serial, 1)) != 5)
56 if (serial_drain(serial) != 0)
62 /* Configures the channel mask based on which channels are enabled. */
63 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
65 struct dev_context *devc;
66 struct sr_channel *channel;
71 devc->channel_mask = 0;
72 for (l = sdi->channels; l; l = l->next) {
75 devc->channel_mask |= 1 << channel->index;
79 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
81 struct dev_context *devc;
82 struct sr_trigger *trigger;
83 struct sr_trigger_stage *stage;
84 struct sr_trigger_match *match;
91 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
92 devc->trigger_mask[i] = 0;
93 devc->trigger_value[i] = 0;
96 if (!(trigger = sr_session_trigger_get(sdi->session)))
99 devc->num_stages = g_slist_length(trigger->stages);
100 if (devc->num_stages > NUM_TRIGGER_STAGES) {
101 sr_err("This device only supports %d trigger stages.",
106 for (l = trigger->stages; l; l = l->next) {
108 for (m = stage->matches; m; m = m->next) {
110 if (!match->channel->enabled)
111 /* Ignore disabled channels with a trigger. */
113 devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
114 if (match->match == SR_TRIGGER_ONE)
115 devc->trigger_value[stage->stage] |= 1 << match->channel->index;
122 SR_PRIV struct dev_context *ols_dev_new(void)
124 struct dev_context *devc;
126 devc = g_malloc0(sizeof(struct dev_context));
128 /* Device-specific settings */
129 devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
131 /* Acquisition settings */
132 devc->limit_samples = devc->capture_ratio = 0;
133 devc->trigger_at = -1;
134 devc->channel_mask = 0xffffffff;
140 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
142 struct sr_dev_inst *sdi;
143 struct dev_context *devc;
144 uint32_t tmp_int, ui;
145 uint8_t key, type, token;
147 GString *tmp_str, *devname, *version;
150 sdi = g_malloc0(sizeof(struct sr_dev_inst));
151 sdi->status = SR_ST_INACTIVE;
152 sdi->driver = &ols_driver_info;
153 devc = ols_dev_new();
156 devname = g_string_new("");
157 version = g_string_new("");
161 delay_ms = serial_timeout(serial, 1);
162 if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
165 sr_dbg("Got metadata key 0x00, metadata ends.");
172 /* NULL-terminated string */
173 tmp_str = g_string_new("");
174 delay_ms = serial_timeout(serial, 1);
175 while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
176 g_string_append_c(tmp_str, tmp_c);
177 sr_dbg("Got metadata key 0x%.2x value '%s'.",
182 devname = g_string_append(devname, tmp_str->str);
185 /* FPGA firmware version */
187 g_string_append(version, ", ");
188 g_string_append(version, "FPGA version ");
189 g_string_append(version, tmp_str->str);
192 /* Ancillary version */
194 g_string_append(version, ", ");
195 g_string_append(version, "Ancillary version ");
196 g_string_append(version, tmp_str->str);
199 sr_info("ols: unknown token 0x%.2x: '%s'",
200 token, tmp_str->str);
203 g_string_free(tmp_str, TRUE);
206 /* 32-bit unsigned integer */
207 delay_ms = serial_timeout(serial, 4);
208 if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
210 tmp_int = RB32(&tmp_int);
211 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
215 /* Number of usable channels */
216 for (ui = 0; ui < tmp_int; ui++)
217 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
218 ols_channel_names[ui]);
221 /* Amount of sample memory available (bytes) */
222 devc->max_samples = tmp_int;
225 /* Amount of dynamic memory available (bytes) */
226 /* what is this for? */
229 /* Maximum sample rate (Hz) */
230 devc->max_samplerate = tmp_int;
233 /* protocol version */
234 devc->protocol_version = tmp_int;
237 sr_info("Unknown token 0x%.2x: 0x%.8x.",
243 /* 8-bit unsigned integer */
244 delay_ms = serial_timeout(serial, 1);
245 if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
247 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
251 /* Number of usable channels */
252 for (ui = 0; ui < tmp_c; ui++)
253 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
254 ols_channel_names[ui]);
257 /* protocol version */
258 devc->protocol_version = tmp_c;
261 sr_info("Unknown token 0x%.2x: 0x%.2x.",
272 sdi->model = devname->str;
273 sdi->version = version->str;
274 g_string_free(devname, FALSE);
275 g_string_free(version, FALSE);
280 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
281 const uint64_t samplerate)
283 struct dev_context *devc;
286 if (devc->max_samplerate && samplerate > devc->max_samplerate)
287 return SR_ERR_SAMPLERATE;
289 if (samplerate > CLOCK_RATE) {
290 sr_info("Enabling demux mode.");
291 devc->flag_reg |= FLAG_DEMUX;
292 devc->flag_reg &= ~FLAG_FILTER;
293 devc->max_channels = NUM_CHANNELS / 2;
294 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
296 sr_info("Disabling demux mode.");
297 devc->flag_reg &= ~FLAG_DEMUX;
298 devc->flag_reg |= FLAG_FILTER;
299 devc->max_channels = NUM_CHANNELS;
300 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
303 /* Calculate actual samplerate used and complain if it is different
304 * from the requested.
306 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
307 if (devc->flag_reg & FLAG_DEMUX)
308 devc->cur_samplerate *= 2;
309 if (devc->cur_samplerate != samplerate)
310 sr_info("Can't match samplerate %" PRIu64 ", using %"
311 PRIu64 ".", samplerate, devc->cur_samplerate);
316 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
318 struct sr_datafeed_packet packet;
319 struct sr_serial_dev_inst *serial;
322 serial_source_remove(sdi->session, serial);
324 /* Terminate session */
325 packet.type = SR_DF_END;
326 sr_session_send(sdi, &packet);
329 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
331 struct dev_context *devc;
332 struct sr_dev_inst *sdi;
333 struct sr_serial_dev_inst *serial;
334 struct sr_datafeed_packet packet;
335 struct sr_datafeed_logic logic;
337 int num_ols_changrp, offset, j;
347 if (devc->num_transfers == 0 && revents == 0) {
348 /* Ignore timeouts as long as we haven't received anything */
352 if (devc->num_transfers++ == 0) {
353 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
354 if (!devc->raw_sample_buf) {
355 sr_err("Sample buffer malloc failed.");
358 /* fill with 1010... for debugging */
359 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
363 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
364 if ((devc->flag_reg & i) == 0) {
369 if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
370 if (serial_read_nonblocking(serial, &byte, 1) != 1)
374 /* Ignore it if we've read enough. */
375 if (devc->num_samples >= devc->limit_samples)
378 devc->sample[devc->num_bytes++] = byte;
379 sr_spew("Received byte 0x%.2x.", byte);
380 if (devc->num_bytes == num_ols_changrp) {
382 devc->cnt_samples_rle++;
384 * Got a full sample. Convert from the OLS's little-endian
385 * sample to the local format.
387 sample = devc->sample[0] | (devc->sample[1] << 8) \
388 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
389 sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
390 if (devc->flag_reg & FLAG_RLE) {
392 * In RLE mode the high bit of the sample is the
393 * "count" flag, meaning this sample is the number
394 * of times the previous sample occurred.
396 if (devc->sample[devc->num_bytes - 1] & 0x80) {
397 /* Clear the high bit. */
398 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
399 devc->rle_count = sample;
400 devc->cnt_samples_rle += devc->rle_count;
401 sr_dbg("RLE count: %u.", devc->rle_count);
406 devc->num_samples += devc->rle_count + 1;
407 if (devc->num_samples > devc->limit_samples) {
408 /* Save us from overrunning the buffer. */
409 devc->rle_count -= devc->num_samples - devc->limit_samples;
410 devc->num_samples = devc->limit_samples;
413 if (num_ols_changrp < 4) {
415 * Some channel groups may have been turned
416 * off, to speed up transfer between the
417 * hardware and the PC. Expand that here before
418 * submitting it over the session bus --
419 * whatever is listening on the bus will be
420 * expecting a full 32-bit sample, based on
421 * the number of channels.
424 memset(devc->tmp_sample, 0, 4);
425 for (i = 0; i < 4; i++) {
426 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
428 * This channel group was
429 * enabled, copy from received
432 devc->tmp_sample[i] = devc->sample[j++];
433 } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
434 /* group 2 & 3 get added to 0 & 1 */
435 devc->tmp_sample[i - 2] = devc->sample[j++];
438 memcpy(devc->sample, devc->tmp_sample, 4);
439 sr_spew("Expanded sample: 0x%.8x.", sample);
443 * the OLS sends its sample buffer backwards.
444 * store it in reverse order here, so we can dump
445 * this on the session bus later.
447 offset = (devc->limit_samples - devc->num_samples) * 4;
448 for (i = 0; i <= devc->rle_count; i++) {
449 memcpy(devc->raw_sample_buf + offset + (i * 4),
452 memset(devc->sample, 0, 4);
458 * This is the main loop telling us a timeout was reached, or
459 * we've acquired all the samples we asked for -- we're done.
460 * Send the (properly-ordered) buffer to the frontend.
462 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
463 devc->cnt_bytes, devc->cnt_samples,
464 devc->cnt_samples_rle);
465 if (devc->trigger_at != -1) {
467 * A trigger was set up, so we need to tell the frontend
470 if (devc->trigger_at > 0) {
471 /* There are pre-trigger samples, send those first. */
472 packet.type = SR_DF_LOGIC;
473 packet.payload = &logic;
474 logic.length = devc->trigger_at * 4;
476 logic.data = devc->raw_sample_buf +
477 (devc->limit_samples - devc->num_samples) * 4;
478 sr_session_send(cb_data, &packet);
481 /* Send the trigger. */
482 packet.type = SR_DF_TRIGGER;
483 sr_session_send(cb_data, &packet);
485 /* Send post-trigger samples. */
486 packet.type = SR_DF_LOGIC;
487 packet.payload = &logic;
488 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
490 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
491 (devc->limit_samples - devc->num_samples) * 4;
492 sr_session_send(cb_data, &packet);
494 /* no trigger was used */
495 packet.type = SR_DF_LOGIC;
496 packet.payload = &logic;
497 logic.length = devc->num_samples * 4;
499 logic.data = devc->raw_sample_buf +
500 (devc->limit_samples - devc->num_samples) * 4;
501 sr_session_send(cb_data, &packet);
503 g_free(devc->raw_sample_buf);
505 serial_flush(serial);
506 abort_acquisition(sdi);