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 SR_PRIV int ols_send_reset(struct sr_serial_dev_inst *serial)
64 for (i = 0; i < 5; i++) {
65 if (send_shortcommand(serial, CMD_RESET) != SR_OK)
72 /* Configures the channel mask based on which channels are enabled. */
73 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
75 struct dev_context *devc;
76 struct sr_channel *channel;
81 devc->channel_mask = 0;
82 for (l = sdi->channels; l; l = l->next) {
85 devc->channel_mask |= 1 << channel->index;
89 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
91 struct dev_context *devc;
92 struct sr_trigger *trigger;
93 struct sr_trigger_stage *stage;
94 struct sr_trigger_match *match;
100 devc->num_stages = 0;
101 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
102 devc->trigger_mask[i] = 0;
103 devc->trigger_value[i] = 0;
106 if (!(trigger = sr_session_trigger_get(sdi->session)))
109 devc->num_stages = g_slist_length(trigger->stages);
110 if (devc->num_stages > NUM_TRIGGER_STAGES) {
111 sr_err("This device only supports %d trigger stages.",
116 for (l = trigger->stages; l; l = l->next) {
118 for (m = stage->matches; m; m = m->next) {
120 if (!match->channel->enabled)
121 /* Ignore disabled channels with a trigger. */
123 devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
124 if (match->match == SR_TRIGGER_ONE)
125 devc->trigger_value[stage->stage] |= 1 << match->channel->index;
132 SR_PRIV struct dev_context *ols_dev_new(void)
134 struct dev_context *devc;
136 devc = g_malloc0(sizeof(struct dev_context));
138 /* Device-specific settings */
139 devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
141 /* Acquisition settings */
142 devc->limit_samples = devc->capture_ratio = 0;
143 devc->trigger_at = -1;
144 devc->channel_mask = 0xffffffff;
150 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
152 struct sr_dev_inst *sdi;
153 struct dev_context *devc;
154 uint32_t tmp_int, ui;
155 uint8_t key, type, token;
157 GString *tmp_str, *devname, *version;
160 sdi = g_malloc0(sizeof(struct sr_dev_inst));
161 sdi->status = SR_ST_INACTIVE;
162 devc = ols_dev_new();
165 devname = g_string_new("");
166 version = g_string_new("");
170 delay_ms = serial_timeout(serial, 1);
171 if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
174 sr_dbg("Got metadata key 0x00, metadata ends.");
181 /* NULL-terminated string */
182 tmp_str = g_string_new("");
183 delay_ms = serial_timeout(serial, 1);
184 while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
185 g_string_append_c(tmp_str, tmp_c);
186 sr_dbg("Got metadata key 0x%.2x value '%s'.",
191 devname = g_string_append(devname, tmp_str->str);
194 /* FPGA firmware version */
196 g_string_append(version, ", ");
197 g_string_append(version, "FPGA version ");
198 g_string_append(version, tmp_str->str);
201 /* Ancillary version */
203 g_string_append(version, ", ");
204 g_string_append(version, "Ancillary version ");
205 g_string_append(version, tmp_str->str);
208 sr_info("ols: unknown token 0x%.2x: '%s'",
209 token, tmp_str->str);
212 g_string_free(tmp_str, TRUE);
215 /* 32-bit unsigned integer */
216 delay_ms = serial_timeout(serial, 4);
217 if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
219 tmp_int = RB32(&tmp_int);
220 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
224 /* Number of usable channels */
225 for (ui = 0; ui < tmp_int; ui++)
226 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
227 ols_channel_names[ui]);
230 /* Amount of sample memory available (bytes) */
231 devc->max_samples = tmp_int;
234 /* Amount of dynamic memory available (bytes) */
235 /* what is this for? */
238 /* Maximum sample rate (Hz) */
239 devc->max_samplerate = tmp_int;
242 /* protocol version */
243 devc->protocol_version = tmp_int;
246 sr_info("Unknown token 0x%.2x: 0x%.8x.",
252 /* 8-bit unsigned integer */
253 delay_ms = serial_timeout(serial, 1);
254 if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
256 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
260 /* Number of usable channels */
261 for (ui = 0; ui < tmp_c; ui++)
262 sr_channel_new(sdi, ui, SR_CHANNEL_LOGIC, TRUE,
263 ols_channel_names[ui]);
266 /* protocol version */
267 devc->protocol_version = tmp_c;
270 sr_info("Unknown token 0x%.2x: 0x%.2x.",
281 sdi->model = devname->str;
282 sdi->version = version->str;
283 g_string_free(devname, FALSE);
284 g_string_free(version, FALSE);
289 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
290 const uint64_t samplerate)
292 struct dev_context *devc;
295 if (devc->max_samplerate && samplerate > devc->max_samplerate)
296 return SR_ERR_SAMPLERATE;
298 if (samplerate > CLOCK_RATE) {
299 sr_info("Enabling demux mode.");
300 devc->flag_reg |= FLAG_DEMUX;
301 devc->flag_reg &= ~FLAG_FILTER;
302 devc->max_channels = NUM_CHANNELS / 2;
303 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
305 sr_info("Disabling demux mode.");
306 devc->flag_reg &= ~FLAG_DEMUX;
307 devc->flag_reg |= FLAG_FILTER;
308 devc->max_channels = NUM_CHANNELS;
309 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
312 /* Calculate actual samplerate used and complain if it is different
313 * from the requested.
315 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
316 if (devc->flag_reg & FLAG_DEMUX)
317 devc->cur_samplerate *= 2;
318 if (devc->cur_samplerate != samplerate)
319 sr_info("Can't match samplerate %" PRIu64 ", using %"
320 PRIu64 ".", samplerate, devc->cur_samplerate);
325 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
327 struct sr_serial_dev_inst *serial;
330 serial_source_remove(sdi->session, serial);
332 std_session_send_df_end(sdi);
335 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
337 struct dev_context *devc;
338 struct sr_dev_inst *sdi;
339 struct sr_serial_dev_inst *serial;
340 struct sr_datafeed_packet packet;
341 struct sr_datafeed_logic logic;
343 int num_ols_changrp, offset, j;
353 if (devc->num_transfers == 0 && revents == 0) {
354 /* Ignore timeouts as long as we haven't received anything */
358 if (devc->num_transfers++ == 0) {
359 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
360 if (!devc->raw_sample_buf) {
361 sr_err("Sample buffer malloc failed.");
364 /* fill with 1010... for debugging */
365 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
369 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
370 if ((devc->flag_reg & i) == 0) {
375 if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
376 if (serial_read_nonblocking(serial, &byte, 1) != 1)
380 /* Ignore it if we've read enough. */
381 if (devc->num_samples >= devc->limit_samples)
384 devc->sample[devc->num_bytes++] = byte;
385 sr_spew("Received byte 0x%.2x.", byte);
386 if (devc->num_bytes == num_ols_changrp) {
388 devc->cnt_samples_rle++;
390 * Got a full sample. Convert from the OLS's little-endian
391 * sample to the local format.
393 sample = devc->sample[0] | (devc->sample[1] << 8) \
394 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
395 sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
396 if (devc->flag_reg & FLAG_RLE) {
398 * In RLE mode the high bit of the sample is the
399 * "count" flag, meaning this sample is the number
400 * of times the previous sample occurred.
402 if (devc->sample[devc->num_bytes - 1] & 0x80) {
403 /* Clear the high bit. */
404 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
405 devc->rle_count = sample;
406 devc->cnt_samples_rle += devc->rle_count;
407 sr_dbg("RLE count: %u.", devc->rle_count);
412 devc->num_samples += devc->rle_count + 1;
413 if (devc->num_samples > devc->limit_samples) {
414 /* Save us from overrunning the buffer. */
415 devc->rle_count -= devc->num_samples - devc->limit_samples;
416 devc->num_samples = devc->limit_samples;
419 if (num_ols_changrp < 4) {
421 * Some channel groups may have been turned
422 * off, to speed up transfer between the
423 * hardware and the PC. Expand that here before
424 * submitting it over the session bus --
425 * whatever is listening on the bus will be
426 * expecting a full 32-bit sample, based on
427 * the number of channels.
430 memset(devc->tmp_sample, 0, 4);
431 for (i = 0; i < 4; i++) {
432 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
434 * This channel group was
435 * enabled, copy from received
438 devc->tmp_sample[i] = devc->sample[j++];
439 } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
440 /* group 2 & 3 get added to 0 & 1 */
441 devc->tmp_sample[i - 2] = devc->sample[j++];
444 memcpy(devc->sample, devc->tmp_sample, 4);
445 sr_spew("Expanded sample: 0x%.8x.", sample);
449 * the OLS sends its sample buffer backwards.
450 * store it in reverse order here, so we can dump
451 * this on the session bus later.
453 offset = (devc->limit_samples - devc->num_samples) * 4;
454 for (i = 0; i <= devc->rle_count; i++) {
455 memcpy(devc->raw_sample_buf + offset + (i * 4),
458 memset(devc->sample, 0, 4);
464 * This is the main loop telling us a timeout was reached, or
465 * we've acquired all the samples we asked for -- we're done.
466 * Send the (properly-ordered) buffer to the frontend.
468 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
469 devc->cnt_bytes, devc->cnt_samples,
470 devc->cnt_samples_rle);
471 if (devc->trigger_at != -1) {
473 * A trigger was set up, so we need to tell the frontend
476 if (devc->trigger_at > 0) {
477 /* There are pre-trigger samples, send those first. */
478 packet.type = SR_DF_LOGIC;
479 packet.payload = &logic;
480 logic.length = devc->trigger_at * 4;
482 logic.data = devc->raw_sample_buf +
483 (devc->limit_samples - devc->num_samples) * 4;
484 sr_session_send(sdi, &packet);
487 /* Send the trigger. */
488 packet.type = SR_DF_TRIGGER;
489 sr_session_send(sdi, &packet);
491 /* Send post-trigger samples. */
492 packet.type = SR_DF_LOGIC;
493 packet.payload = &logic;
494 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
496 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
497 (devc->limit_samples - devc->num_samples) * 4;
498 sr_session_send(sdi, &packet);
500 /* no trigger was used */
501 packet.type = SR_DF_LOGIC;
502 packet.payload = &logic;
503 logic.length = devc->num_samples * 4;
505 logic.data = devc->raw_sample_buf +
506 (devc->limit_samples - devc->num_samples) * 4;
507 sr_session_send(sdi, &packet);
509 g_free(devc->raw_sample_buf);
511 serial_flush(serial);
512 abort_acquisition(sdi);