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 send_shortcommand(struct sr_serial_dev_inst *serial,
28 sr_dbg("Sending cmd 0x%.2x.", command);
30 if (serial_write_blocking(serial, buf, 1, serial_timeout(serial, 1)) != 1)
33 if (serial_drain(serial) != 0)
39 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
40 uint8_t command, uint8_t *data)
44 sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command,
45 data[0], data[1], data[2], data[3]);
51 if (serial_write_blocking(serial, buf, 5, serial_timeout(serial, 1)) != 5)
54 if (serial_drain(serial) != 0)
60 /* Configures the channel mask based on which channels are enabled. */
61 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
63 struct dev_context *devc;
64 struct sr_channel *channel;
69 devc->channel_mask = 0;
70 for (l = sdi->channels; l; l = l->next) {
73 devc->channel_mask |= 1 << channel->index;
77 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
79 struct dev_context *devc;
80 struct sr_trigger *trigger;
81 struct sr_trigger_stage *stage;
82 struct sr_trigger_match *match;
89 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
90 devc->trigger_mask[i] = 0;
91 devc->trigger_value[i] = 0;
94 if (!(trigger = sr_session_trigger_get(sdi->session)))
97 devc->num_stages = g_slist_length(trigger->stages);
98 if (devc->num_stages > NUM_TRIGGER_STAGES) {
99 sr_err("This device only supports %d trigger stages.",
104 for (l = trigger->stages; l; l = l->next) {
106 for (m = stage->matches; m; m = m->next) {
108 if (!match->channel->enabled)
109 /* Ignore disabled channels with a trigger. */
111 devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
112 if (match->match == SR_TRIGGER_ONE)
113 devc->trigger_value[stage->stage] |= 1 << match->channel->index;
120 SR_PRIV struct dev_context *ols_dev_new(void)
122 struct dev_context *devc;
124 devc = g_malloc0(sizeof(struct dev_context));
126 /* Device-specific settings */
127 devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
129 /* Acquisition settings */
130 devc->limit_samples = devc->capture_ratio = 0;
131 devc->trigger_at = -1;
132 devc->channel_mask = 0xffffffff;
138 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
140 struct sr_dev_inst *sdi;
141 struct dev_context *devc;
142 uint32_t tmp_int, ui;
143 uint8_t key, type, token;
145 GString *tmp_str, *devname, *version;
148 sdi = g_malloc0(sizeof(struct sr_dev_inst));
149 sdi->status = SR_ST_INACTIVE;
150 devc = ols_dev_new();
153 devname = g_string_new("");
154 version = g_string_new("");
158 delay_ms = serial_timeout(serial, 1);
159 if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
162 sr_dbg("Got metadata key 0x00, metadata ends.");
169 /* NULL-terminated string */
170 tmp_str = g_string_new("");
171 delay_ms = serial_timeout(serial, 1);
172 while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
173 g_string_append_c(tmp_str, tmp_c);
174 sr_dbg("Got metadata key 0x%.2x value '%s'.",
179 devname = g_string_append(devname, tmp_str->str);
182 /* FPGA firmware version */
184 g_string_append(version, ", ");
185 g_string_append(version, "FPGA version ");
186 g_string_append(version, tmp_str->str);
189 /* Ancillary version */
191 g_string_append(version, ", ");
192 g_string_append(version, "Ancillary version ");
193 g_string_append(version, tmp_str->str);
196 sr_info("ols: unknown token 0x%.2x: '%s'",
197 token, tmp_str->str);
200 g_string_free(tmp_str, TRUE);
203 /* 32-bit unsigned integer */
204 delay_ms = serial_timeout(serial, 4);
205 if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
207 tmp_int = RB32(&tmp_int);
208 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
212 /* Number of usable channels */
213 for (ui = 0; ui < tmp_int; ui++)
214 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
215 ols_channel_names[ui]);
218 /* Amount of sample memory available (bytes) */
219 devc->max_samples = tmp_int;
222 /* Amount of dynamic memory available (bytes) */
223 /* what is this for? */
226 /* Maximum sample rate (Hz) */
227 devc->max_samplerate = tmp_int;
230 /* protocol version */
231 devc->protocol_version = tmp_int;
234 sr_info("Unknown token 0x%.2x: 0x%.8x.",
240 /* 8-bit unsigned integer */
241 delay_ms = serial_timeout(serial, 1);
242 if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
244 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
248 /* Number of usable channels */
249 for (ui = 0; ui < tmp_c; ui++)
250 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
251 ols_channel_names[ui]);
254 /* protocol version */
255 devc->protocol_version = tmp_c;
258 sr_info("Unknown token 0x%.2x: 0x%.2x.",
269 sdi->model = devname->str;
270 sdi->version = version->str;
271 g_string_free(devname, FALSE);
272 g_string_free(version, FALSE);
277 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
278 const uint64_t samplerate)
280 struct dev_context *devc;
283 if (devc->max_samplerate && samplerate > devc->max_samplerate)
284 return SR_ERR_SAMPLERATE;
286 if (samplerate > CLOCK_RATE) {
287 sr_info("Enabling demux mode.");
288 devc->flag_reg |= FLAG_DEMUX;
289 devc->flag_reg &= ~FLAG_FILTER;
290 devc->max_channels = NUM_CHANNELS / 2;
291 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
293 sr_info("Disabling demux mode.");
294 devc->flag_reg &= ~FLAG_DEMUX;
295 devc->flag_reg |= FLAG_FILTER;
296 devc->max_channels = NUM_CHANNELS;
297 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
300 /* Calculate actual samplerate used and complain if it is different
301 * from the requested.
303 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
304 if (devc->flag_reg & FLAG_DEMUX)
305 devc->cur_samplerate *= 2;
306 if (devc->cur_samplerate != samplerate)
307 sr_info("Can't match samplerate %" PRIu64 ", using %"
308 PRIu64 ".", samplerate, devc->cur_samplerate);
313 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
315 struct sr_serial_dev_inst *serial;
318 serial_source_remove(sdi->session, serial);
320 std_session_send_df_end(sdi);
323 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
325 struct dev_context *devc;
326 struct sr_dev_inst *sdi;
327 struct sr_serial_dev_inst *serial;
328 struct sr_datafeed_packet packet;
329 struct sr_datafeed_logic logic;
331 int num_ols_changrp, offset, j;
341 if (devc->num_transfers == 0 && revents == 0) {
342 /* Ignore timeouts as long as we haven't received anything */
346 if (devc->num_transfers++ == 0) {
347 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
348 if (!devc->raw_sample_buf) {
349 sr_err("Sample buffer malloc failed.");
352 /* fill with 1010... for debugging */
353 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
357 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
358 if ((devc->flag_reg & i) == 0) {
363 if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
364 if (serial_read_nonblocking(serial, &byte, 1) != 1)
368 /* Ignore it if we've read enough. */
369 if (devc->num_samples >= devc->limit_samples)
372 devc->sample[devc->num_bytes++] = byte;
373 sr_spew("Received byte 0x%.2x.", byte);
374 if (devc->num_bytes == num_ols_changrp) {
376 devc->cnt_samples_rle++;
378 * Got a full sample. Convert from the OLS's little-endian
379 * sample to the local format.
381 sample = devc->sample[0] | (devc->sample[1] << 8) \
382 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
383 sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
384 if (devc->flag_reg & FLAG_RLE) {
386 * In RLE mode the high bit of the sample is the
387 * "count" flag, meaning this sample is the number
388 * of times the previous sample occurred.
390 if (devc->sample[devc->num_bytes - 1] & 0x80) {
391 /* Clear the high bit. */
392 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
393 devc->rle_count = sample;
394 devc->cnt_samples_rle += devc->rle_count;
395 sr_dbg("RLE count: %u.", devc->rle_count);
400 devc->num_samples += devc->rle_count + 1;
401 if (devc->num_samples > devc->limit_samples) {
402 /* Save us from overrunning the buffer. */
403 devc->rle_count -= devc->num_samples - devc->limit_samples;
404 devc->num_samples = devc->limit_samples;
407 if (num_ols_changrp < 4) {
409 * Some channel groups may have been turned
410 * off, to speed up transfer between the
411 * hardware and the PC. Expand that here before
412 * submitting it over the session bus --
413 * whatever is listening on the bus will be
414 * expecting a full 32-bit sample, based on
415 * the number of channels.
418 memset(devc->tmp_sample, 0, 4);
419 for (i = 0; i < 4; i++) {
420 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
422 * This channel group was
423 * enabled, copy from received
426 devc->tmp_sample[i] = devc->sample[j++];
427 } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
428 /* group 2 & 3 get added to 0 & 1 */
429 devc->tmp_sample[i - 2] = devc->sample[j++];
432 memcpy(devc->sample, devc->tmp_sample, 4);
433 sr_spew("Expanded sample: 0x%.8x.", sample);
437 * the OLS sends its sample buffer backwards.
438 * store it in reverse order here, so we can dump
439 * this on the session bus later.
441 offset = (devc->limit_samples - devc->num_samples) * 4;
442 for (i = 0; i <= devc->rle_count; i++) {
443 memcpy(devc->raw_sample_buf + offset + (i * 4),
446 memset(devc->sample, 0, 4);
452 * This is the main loop telling us a timeout was reached, or
453 * we've acquired all the samples we asked for -- we're done.
454 * Send the (properly-ordered) buffer to the frontend.
456 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
457 devc->cnt_bytes, devc->cnt_samples,
458 devc->cnt_samples_rle);
459 if (devc->trigger_at != -1) {
461 * A trigger was set up, so we need to tell the frontend
464 if (devc->trigger_at > 0) {
465 /* There are pre-trigger samples, send those first. */
466 packet.type = SR_DF_LOGIC;
467 packet.payload = &logic;
468 logic.length = devc->trigger_at * 4;
470 logic.data = devc->raw_sample_buf +
471 (devc->limit_samples - devc->num_samples) * 4;
472 sr_session_send(sdi, &packet);
475 /* Send the trigger. */
476 packet.type = SR_DF_TRIGGER;
477 sr_session_send(sdi, &packet);
479 /* Send post-trigger samples. */
480 packet.type = SR_DF_LOGIC;
481 packet.payload = &logic;
482 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
484 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
485 (devc->limit_samples - devc->num_samples) * 4;
486 sr_session_send(sdi, &packet);
488 /* no trigger was used */
489 packet.type = SR_DF_LOGIC;
490 packet.payload = &logic;
491 logic.length = devc->num_samples * 4;
493 logic.data = devc->raw_sample_buf +
494 (devc->limit_samples - devc->num_samples) * 4;
495 sr_session_send(sdi, &packet);
497 g_free(devc->raw_sample_buf);
499 serial_flush(serial);
500 abort_acquisition(sdi);