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) != SR_OK)
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) != SR_OK)
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));
137 devc->trigger_at_smpl = OLS_NO_TRIGGER;
142 static void ols_channel_new(struct sr_dev_inst *sdi, int num_chan)
144 struct dev_context *devc = sdi->priv;
147 for (i = 0; i < num_chan; i++)
148 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
149 ols_channel_names[i]);
151 devc->max_channels = num_chan;
154 static void metadata_quirks(struct sr_dev_inst *sdi)
156 struct dev_context *devc;
165 is_shrimp = sdi->model && strcmp(sdi->model, "Shrimp1.0") == 0;
167 if (!devc->max_channels)
168 ols_channel_new(sdi, 4);
169 if (!devc->max_samples)
170 devc->max_samples = 256 * 1024;
171 if (!devc->max_samplerate)
172 devc->max_samplerate = SR_MHZ(20);
176 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
178 struct sr_dev_inst *sdi;
179 struct dev_context *devc;
181 uint8_t key, type, token;
183 GString *tmp_str, *devname, *version;
186 sdi = g_malloc0(sizeof(struct sr_dev_inst));
187 sdi->status = SR_ST_INACTIVE;
188 devc = ols_dev_new();
191 devname = g_string_new("");
192 version = g_string_new("");
196 delay_ms = serial_timeout(serial, 1);
197 if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
200 sr_dbg("Got metadata key 0x00, metadata ends.");
207 /* NULL-terminated string */
208 tmp_str = g_string_new("");
209 delay_ms = serial_timeout(serial, 1);
210 while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
211 g_string_append_c(tmp_str, tmp_c);
212 sr_dbg("Got metadata key 0x%.2x value '%s'.",
217 devname = g_string_append(devname, tmp_str->str);
220 /* FPGA firmware version */
222 g_string_append(version, ", ");
223 g_string_append(version, "FPGA version ");
224 g_string_append(version, tmp_str->str);
227 /* Ancillary version */
229 g_string_append(version, ", ");
230 g_string_append(version, "Ancillary version ");
231 g_string_append(version, tmp_str->str);
234 sr_info("ols: unknown token 0x%.2x: '%s'",
235 token, tmp_str->str);
238 g_string_free(tmp_str, TRUE);
241 /* 32-bit unsigned integer */
242 delay_ms = serial_timeout(serial, 4);
243 if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
245 tmp_int = RB32(&tmp_int);
246 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
250 /* Number of usable channels */
251 ols_channel_new(sdi, tmp_int);
254 /* Amount of sample memory available (bytes) */
255 devc->max_samples = tmp_int;
258 /* Amount of dynamic memory available (bytes) */
259 /* what is this for? */
262 /* Maximum sample rate (Hz) */
263 devc->max_samplerate = tmp_int;
266 /* protocol version */
267 devc->protocol_version = tmp_int;
270 sr_info("Unknown token 0x%.2x: 0x%.8x.",
276 /* 8-bit unsigned integer */
277 delay_ms = serial_timeout(serial, 1);
278 if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
280 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
284 /* Number of usable channels */
285 ols_channel_new(sdi, tmp_c);
288 /* protocol version */
289 devc->protocol_version = tmp_c;
292 sr_info("Unknown token 0x%.2x: 0x%.2x.",
303 sdi->model = devname->str;
304 sdi->version = version->str;
305 g_string_free(devname, FALSE);
306 g_string_free(version, FALSE);
308 /* Optionally amend received metadata, model specific quirks. */
309 metadata_quirks(sdi);
314 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
315 const uint64_t samplerate)
317 struct dev_context *devc;
320 if (devc->max_samplerate && samplerate > devc->max_samplerate)
321 return SR_ERR_SAMPLERATE;
323 if (samplerate > CLOCK_RATE) {
324 sr_info("Enabling demux mode.");
325 devc->capture_flags |= CAPTURE_FLAG_DEMUX;
326 devc->capture_flags &= ~CAPTURE_FLAG_NOISE_FILTER;
327 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
329 sr_info("Disabling demux mode.");
330 devc->capture_flags &= ~CAPTURE_FLAG_DEMUX;
331 devc->capture_flags |= CAPTURE_FLAG_NOISE_FILTER;
332 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
335 /* Calculate actual samplerate used and complain if it is different
336 * from the requested.
338 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
339 if (devc->capture_flags & CAPTURE_FLAG_DEMUX)
340 devc->cur_samplerate *= 2;
341 if (devc->cur_samplerate != samplerate)
342 sr_info("Can't match samplerate %" PRIu64 ", using %"
343 PRIu64 ".", samplerate, devc->cur_samplerate);
348 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
350 struct sr_serial_dev_inst *serial;
353 serial_source_remove(sdi->session, serial);
355 std_session_send_df_end(sdi);
358 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
360 struct dev_context *devc;
361 struct sr_dev_inst *sdi;
362 struct sr_serial_dev_inst *serial;
363 struct sr_datafeed_packet packet;
364 struct sr_datafeed_logic logic;
366 int num_ols_changrp, offset, j;
376 if (devc->num_transfers == 0 && revents == 0) {
377 /* Ignore timeouts as long as we haven't received anything */
381 if (devc->num_transfers++ == 0) {
382 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
383 if (!devc->raw_sample_buf) {
384 sr_err("Sample buffer malloc failed.");
387 /* fill with 1010... for debugging */
388 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
392 for (i = 0x20; i > 0x02; i >>= 1) {
393 if ((devc->capture_flags & i) == 0) {
398 if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
399 if (serial_read_nonblocking(serial, &byte, 1) != 1)
403 /* Ignore it if we've read enough. */
404 if (devc->num_samples >= devc->limit_samples)
407 devc->sample[devc->num_bytes++] = byte;
408 sr_spew("Received byte 0x%.2x.", byte);
409 if (devc->num_bytes == num_ols_changrp) {
411 devc->cnt_samples_rle++;
413 * Got a full sample. Convert from the OLS's little-endian
414 * sample to the local format.
416 sample = devc->sample[0] | (devc->sample[1] << 8) \
417 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
418 sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
419 if (devc->capture_flags & CAPTURE_FLAG_RLE) {
421 * In RLE mode the high bit of the sample is the
422 * "count" flag, meaning this sample is the number
423 * of times the previous sample occurred.
425 if (devc->sample[devc->num_bytes - 1] & 0x80) {
426 /* Clear the high bit. */
427 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
428 devc->rle_count = sample;
429 devc->cnt_samples_rle += devc->rle_count;
430 sr_dbg("RLE count: %u.", devc->rle_count);
435 devc->num_samples += devc->rle_count + 1;
436 if (devc->num_samples > devc->limit_samples) {
437 /* Save us from overrunning the buffer. */
438 devc->rle_count -= devc->num_samples - devc->limit_samples;
439 devc->num_samples = devc->limit_samples;
442 if (num_ols_changrp < 4) {
444 * Some channel groups may have been turned
445 * off, to speed up transfer between the
446 * hardware and the PC. Expand that here before
447 * submitting it over the session bus --
448 * whatever is listening on the bus will be
449 * expecting a full 32-bit sample, based on
450 * the number of channels.
453 memset(devc->tmp_sample, 0, 4);
454 for (i = 0; i < 4; i++) {
455 if (((devc->capture_flags >> 2) & (1 << i)) == 0) {
457 * This channel group was
458 * enabled, copy from received
461 devc->tmp_sample[i] = devc->sample[j++];
462 } else if (devc->capture_flags & CAPTURE_FLAG_DEMUX && (i > 2)) {
463 /* group 2 & 3 get added to 0 & 1 */
464 devc->tmp_sample[i - 2] = devc->sample[j++];
467 memcpy(devc->sample, devc->tmp_sample, 4);
468 sr_spew("Expanded sample: 0x%.8x.", sample);
472 * the OLS sends its sample buffer backwards.
473 * store it in reverse order here, so we can dump
474 * this on the session bus later.
476 offset = (devc->limit_samples - devc->num_samples) * 4;
477 for (i = 0; i <= devc->rle_count; i++) {
478 memcpy(devc->raw_sample_buf + offset + (i * 4),
481 memset(devc->sample, 0, 4);
487 * This is the main loop telling us a timeout was reached, or
488 * we've acquired all the samples we asked for -- we're done.
489 * Send the (properly-ordered) buffer to the frontend.
491 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
492 devc->cnt_bytes, devc->cnt_samples,
493 devc->cnt_samples_rle);
494 if (devc->trigger_at_smpl != OLS_NO_TRIGGER) {
496 * A trigger was set up, so we need to tell the frontend
499 if (devc->trigger_at_smpl > 0) {
500 /* There are pre-trigger samples, send those first. */
501 packet.type = SR_DF_LOGIC;
502 packet.payload = &logic;
503 logic.length = devc->trigger_at_smpl * 4;
505 logic.data = devc->raw_sample_buf +
506 (devc->limit_samples - devc->num_samples) * 4;
507 sr_session_send(sdi, &packet);
510 /* Send the trigger. */
511 std_session_send_df_trigger(sdi);
514 /* Send post-trigger / all captured samples. */
515 int num_pre_trigger_samples = devc->trigger_at_smpl == OLS_NO_TRIGGER
516 ? 0 : devc->trigger_at_smpl;
517 packet.type = SR_DF_LOGIC;
518 packet.payload = &logic;
519 logic.length = (devc->num_samples - num_pre_trigger_samples) * 4;
521 logic.data = devc->raw_sample_buf + (num_pre_trigger_samples +
522 devc->limit_samples - devc->num_samples) * 4;
523 sr_session_send(sdi, &packet);
525 g_free(devc->raw_sample_buf);
527 serial_flush(serial);
528 abort_acquisition(sdi);