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 if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
128 sr_err("Device context malloc failed.");
132 /* Device-specific settings */
133 devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
135 /* Acquisition settings */
136 devc->limit_samples = devc->capture_ratio = 0;
137 devc->trigger_at = -1;
138 devc->channel_mask = 0xffffffff;
144 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
146 struct sr_dev_inst *sdi;
147 struct dev_context *devc;
148 struct sr_channel *ch;
149 uint32_t tmp_int, ui;
150 uint8_t key, type, token;
152 GString *tmp_str, *devname, *version;
155 sdi = sr_dev_inst_new();
156 sdi->status = SR_ST_INACTIVE;
158 devc = ols_dev_new();
161 devname = g_string_new("");
162 version = g_string_new("");
166 delay_ms = serial_timeout(serial, 1);
167 if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
170 sr_dbg("Got metadata key 0x00, metadata ends.");
177 /* NULL-terminated string */
178 tmp_str = g_string_new("");
179 delay_ms = serial_timeout(serial, 1);
180 while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
181 g_string_append_c(tmp_str, tmp_c);
182 sr_dbg("Got metadata key 0x%.2x value '%s'.",
187 devname = g_string_append(devname, tmp_str->str);
190 /* FPGA firmware version */
192 g_string_append(version, ", ");
193 g_string_append(version, "FPGA version ");
194 g_string_append(version, tmp_str->str);
197 /* Ancillary version */
199 g_string_append(version, ", ");
200 g_string_append(version, "Ancillary version ");
201 g_string_append(version, tmp_str->str);
204 sr_info("ols: unknown token 0x%.2x: '%s'",
205 token, tmp_str->str);
208 g_string_free(tmp_str, TRUE);
211 /* 32-bit unsigned integer */
212 delay_ms = serial_timeout(serial, 4);
213 if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
215 tmp_int = RB32(&tmp_int);
216 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
220 /* Number of usable channels */
221 for (ui = 0; ui < tmp_int; ui++) {
222 if (!(ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE,
223 ols_channel_names[ui])))
225 sdi->channels = g_slist_append(sdi->channels, ch);
229 /* Amount of sample memory available (bytes) */
230 devc->max_samples = tmp_int;
233 /* Amount of dynamic memory available (bytes) */
234 /* what is this for? */
237 /* Maximum sample rate (hz) */
238 devc->max_samplerate = tmp_int;
241 /* protocol version */
242 devc->protocol_version = tmp_int;
245 sr_info("Unknown token 0x%.2x: 0x%.8x.",
251 /* 8-bit unsigned integer */
252 delay_ms = serial_timeout(serial, 1);
253 if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
255 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
259 /* Number of usable channels */
260 for (ui = 0; ui < tmp_c; ui++) {
261 if (!(ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE,
262 ols_channel_names[ui])))
264 sdi->channels = g_slist_append(sdi->channels, ch);
268 /* protocol version */
269 devc->protocol_version = tmp_c;
272 sr_info("Unknown token 0x%.2x: 0x%.2x.",
283 sdi->model = devname->str;
284 sdi->version = version->str;
285 g_string_free(devname, FALSE);
286 g_string_free(version, FALSE);
291 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
292 const uint64_t samplerate)
294 struct dev_context *devc;
297 if (devc->max_samplerate && samplerate > devc->max_samplerate)
298 return SR_ERR_SAMPLERATE;
300 if (samplerate > CLOCK_RATE) {
301 sr_info("Enabling demux mode.");
302 devc->flag_reg |= FLAG_DEMUX;
303 devc->flag_reg &= ~FLAG_FILTER;
304 devc->max_channels = NUM_CHANNELS / 2;
305 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
307 sr_info("Disabling demux mode.");
308 devc->flag_reg &= ~FLAG_DEMUX;
309 devc->flag_reg |= FLAG_FILTER;
310 devc->max_channels = NUM_CHANNELS;
311 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
314 /* Calculate actual samplerate used and complain if it is different
315 * from the requested.
317 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
318 if (devc->flag_reg & FLAG_DEMUX)
319 devc->cur_samplerate *= 2;
320 if (devc->cur_samplerate != samplerate)
321 sr_info("Can't match samplerate %" PRIu64 ", using %"
322 PRIu64 ".", samplerate, devc->cur_samplerate);
327 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
329 struct sr_datafeed_packet packet;
330 struct sr_serial_dev_inst *serial;
333 serial_source_remove(sdi->session, serial);
335 /* Terminate session */
336 packet.type = SR_DF_END;
337 sr_session_send(sdi, &packet);
340 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
342 struct dev_context *devc;
343 struct sr_dev_inst *sdi;
344 struct sr_serial_dev_inst *serial;
345 struct sr_datafeed_packet packet;
346 struct sr_datafeed_logic logic;
348 int num_ols_changrp, offset, j;
358 if (devc->num_transfers++ == 0) {
360 * First time round, means the device started sending data,
361 * and will not stop until done. If it stops sending for
362 * longer than it takes to send a byte, that means it's
363 * finished. We'll double that to 30ms to be sure...
365 serial_source_remove(sdi->session, serial);
366 serial_source_add(sdi->session, serial, G_IO_IN, 30,
367 ols_receive_data, cb_data);
368 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
369 if (!devc->raw_sample_buf) {
370 sr_err("Sample buffer malloc failed.");
373 /* fill with 1010... for debugging */
374 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
378 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
379 if ((devc->flag_reg & i) == 0) {
384 if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
385 if (serial_read_nonblocking(serial, &byte, 1) != 1)
389 /* Ignore it if we've read enough. */
390 if (devc->num_samples >= devc->limit_samples)
393 devc->sample[devc->num_bytes++] = byte;
394 sr_spew("Received byte 0x%.2x.", byte);
395 if (devc->num_bytes == num_ols_changrp) {
397 devc->cnt_samples_rle++;
399 * Got a full sample. Convert from the OLS's little-endian
400 * sample to the local format.
402 sample = devc->sample[0] | (devc->sample[1] << 8) \
403 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
404 sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
405 if (devc->flag_reg & FLAG_RLE) {
407 * In RLE mode the high bit of the sample is the
408 * "count" flag, meaning this sample is the number
409 * of times the previous sample occurred.
411 if (devc->sample[devc->num_bytes - 1] & 0x80) {
412 /* Clear the high bit. */
413 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
414 devc->rle_count = sample;
415 devc->cnt_samples_rle += devc->rle_count;
416 sr_dbg("RLE count: %u.", devc->rle_count);
421 devc->num_samples += devc->rle_count + 1;
422 if (devc->num_samples > devc->limit_samples) {
423 /* Save us from overrunning the buffer. */
424 devc->rle_count -= devc->num_samples - devc->limit_samples;
425 devc->num_samples = devc->limit_samples;
428 if (num_ols_changrp < 4) {
430 * Some channel groups may have been turned
431 * off, to speed up transfer between the
432 * hardware and the PC. Expand that here before
433 * submitting it over the session bus --
434 * whatever is listening on the bus will be
435 * expecting a full 32-bit sample, based on
436 * the number of channels.
439 memset(devc->tmp_sample, 0, 4);
440 for (i = 0; i < 4; i++) {
441 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
443 * This channel group was
444 * enabled, copy from received
447 devc->tmp_sample[i] = devc->sample[j++];
448 } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
449 /* group 2 & 3 get added to 0 & 1 */
450 devc->tmp_sample[i - 2] = devc->sample[j++];
453 memcpy(devc->sample, devc->tmp_sample, 4);
454 sr_spew("Expanded sample: 0x%.8x.", sample);
458 * the OLS sends its sample buffer backwards.
459 * store it in reverse order here, so we can dump
460 * this on the session bus later.
462 offset = (devc->limit_samples - devc->num_samples) * 4;
463 for (i = 0; i <= devc->rle_count; i++) {
464 memcpy(devc->raw_sample_buf + offset + (i * 4),
467 memset(devc->sample, 0, 4);
473 * This is the main loop telling us a timeout was reached, or
474 * we've acquired all the samples we asked for -- we're done.
475 * Send the (properly-ordered) buffer to the frontend.
477 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
478 devc->cnt_bytes, devc->cnt_samples,
479 devc->cnt_samples_rle);
480 if (devc->trigger_at != -1) {
482 * A trigger was set up, so we need to tell the frontend
485 if (devc->trigger_at > 0) {
486 /* There are pre-trigger samples, send those first. */
487 packet.type = SR_DF_LOGIC;
488 packet.payload = &logic;
489 logic.length = devc->trigger_at * 4;
491 logic.data = devc->raw_sample_buf +
492 (devc->limit_samples - devc->num_samples) * 4;
493 sr_session_send(cb_data, &packet);
496 /* Send the trigger. */
497 packet.type = SR_DF_TRIGGER;
498 sr_session_send(cb_data, &packet);
500 /* Send post-trigger samples. */
501 packet.type = SR_DF_LOGIC;
502 packet.payload = &logic;
503 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
505 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
506 (devc->limit_samples - devc->num_samples) * 4;
507 sr_session_send(cb_data, &packet);
509 /* no trigger was used */
510 packet.type = SR_DF_LOGIC;
511 packet.payload = &logic;
512 logic.length = devc->num_samples * 4;
514 logic.data = devc->raw_sample_buf +
515 (devc->limit_samples - devc->num_samples) * 4;
516 sr_session_send(cb_data, &packet);
518 g_free(devc->raw_sample_buf);
520 serial_flush(serial);
521 abort_acquisition(sdi);