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 devc = g_malloc0(sizeof(struct dev_context));
129 /* Device-specific settings */
130 devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
132 /* Acquisition settings */
133 devc->limit_samples = devc->capture_ratio = 0;
134 devc->trigger_at = -1;
135 devc->channel_mask = 0xffffffff;
141 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial)
143 struct sr_dev_inst *sdi;
144 struct dev_context *devc;
145 struct sr_channel *ch;
146 uint32_t tmp_int, ui;
147 uint8_t key, type, token;
149 GString *tmp_str, *devname, *version;
152 sdi = g_malloc0(sizeof(struct sr_dev_inst));
153 sdi->status = SR_ST_INACTIVE;
155 devc = ols_dev_new();
158 devname = g_string_new("");
159 version = g_string_new("");
163 delay_ms = serial_timeout(serial, 1);
164 if (serial_read_blocking(serial, &key, 1, delay_ms) != 1)
167 sr_dbg("Got metadata key 0x00, metadata ends.");
174 /* NULL-terminated string */
175 tmp_str = g_string_new("");
176 delay_ms = serial_timeout(serial, 1);
177 while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0')
178 g_string_append_c(tmp_str, tmp_c);
179 sr_dbg("Got metadata key 0x%.2x value '%s'.",
184 devname = g_string_append(devname, tmp_str->str);
187 /* FPGA firmware version */
189 g_string_append(version, ", ");
190 g_string_append(version, "FPGA version ");
191 g_string_append(version, tmp_str->str);
194 /* Ancillary version */
196 g_string_append(version, ", ");
197 g_string_append(version, "Ancillary version ");
198 g_string_append(version, tmp_str->str);
201 sr_info("ols: unknown token 0x%.2x: '%s'",
202 token, tmp_str->str);
205 g_string_free(tmp_str, TRUE);
208 /* 32-bit unsigned integer */
209 delay_ms = serial_timeout(serial, 4);
210 if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4)
212 tmp_int = RB32(&tmp_int);
213 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
217 /* Number of usable channels */
218 for (ui = 0; ui < tmp_int; ui++) {
219 ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE,
220 ols_channel_names[ui]);
221 sdi->channels = g_slist_append(sdi->channels, ch);
225 /* Amount of sample memory available (bytes) */
226 devc->max_samples = tmp_int;
229 /* Amount of dynamic memory available (bytes) */
230 /* what is this for? */
233 /* Maximum sample rate (hz) */
234 devc->max_samplerate = tmp_int;
237 /* protocol version */
238 devc->protocol_version = tmp_int;
241 sr_info("Unknown token 0x%.2x: 0x%.8x.",
247 /* 8-bit unsigned integer */
248 delay_ms = serial_timeout(serial, 1);
249 if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1)
251 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
255 /* Number of usable channels */
256 for (ui = 0; ui < tmp_c; ui++) {
257 ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE,
258 ols_channel_names[ui]);
259 sdi->channels = g_slist_append(sdi->channels, ch);
263 /* protocol version */
264 devc->protocol_version = tmp_c;
267 sr_info("Unknown token 0x%.2x: 0x%.2x.",
278 sdi->model = devname->str;
279 sdi->version = version->str;
280 g_string_free(devname, FALSE);
281 g_string_free(version, FALSE);
286 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
287 const uint64_t samplerate)
289 struct dev_context *devc;
292 if (devc->max_samplerate && samplerate > devc->max_samplerate)
293 return SR_ERR_SAMPLERATE;
295 if (samplerate > CLOCK_RATE) {
296 sr_info("Enabling demux mode.");
297 devc->flag_reg |= FLAG_DEMUX;
298 devc->flag_reg &= ~FLAG_FILTER;
299 devc->max_channels = NUM_CHANNELS / 2;
300 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
302 sr_info("Disabling demux mode.");
303 devc->flag_reg &= ~FLAG_DEMUX;
304 devc->flag_reg |= FLAG_FILTER;
305 devc->max_channels = NUM_CHANNELS;
306 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
309 /* Calculate actual samplerate used and complain if it is different
310 * from the requested.
312 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
313 if (devc->flag_reg & FLAG_DEMUX)
314 devc->cur_samplerate *= 2;
315 if (devc->cur_samplerate != samplerate)
316 sr_info("Can't match samplerate %" PRIu64 ", using %"
317 PRIu64 ".", samplerate, devc->cur_samplerate);
322 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
324 struct sr_datafeed_packet packet;
325 struct sr_serial_dev_inst *serial;
328 serial_source_remove(sdi->session, serial);
330 /* Terminate session */
331 packet.type = SR_DF_END;
332 sr_session_send(sdi, &packet);
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) {
355 * First time round, means the device started sending data,
356 * and will not stop until done. If it stops sending for
357 * longer than it takes to send a byte, that means it's
358 * finished. We'll double that to 30ms to be sure...
360 serial_source_remove(sdi->session, serial);
361 serial_source_add(sdi->session, serial, G_IO_IN, 30,
362 ols_receive_data, cb_data);
363 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
364 if (!devc->raw_sample_buf) {
365 sr_err("Sample buffer malloc failed.");
368 /* fill with 1010... for debugging */
369 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
373 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
374 if ((devc->flag_reg & i) == 0) {
379 if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
380 if (serial_read_nonblocking(serial, &byte, 1) != 1)
384 /* Ignore it if we've read enough. */
385 if (devc->num_samples >= devc->limit_samples)
388 devc->sample[devc->num_bytes++] = byte;
389 sr_spew("Received byte 0x%.2x.", byte);
390 if (devc->num_bytes == num_ols_changrp) {
392 devc->cnt_samples_rle++;
394 * Got a full sample. Convert from the OLS's little-endian
395 * sample to the local format.
397 sample = devc->sample[0] | (devc->sample[1] << 8) \
398 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
399 sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
400 if (devc->flag_reg & FLAG_RLE) {
402 * In RLE mode the high bit of the sample is the
403 * "count" flag, meaning this sample is the number
404 * of times the previous sample occurred.
406 if (devc->sample[devc->num_bytes - 1] & 0x80) {
407 /* Clear the high bit. */
408 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
409 devc->rle_count = sample;
410 devc->cnt_samples_rle += devc->rle_count;
411 sr_dbg("RLE count: %u.", devc->rle_count);
416 devc->num_samples += devc->rle_count + 1;
417 if (devc->num_samples > devc->limit_samples) {
418 /* Save us from overrunning the buffer. */
419 devc->rle_count -= devc->num_samples - devc->limit_samples;
420 devc->num_samples = devc->limit_samples;
423 if (num_ols_changrp < 4) {
425 * Some channel groups may have been turned
426 * off, to speed up transfer between the
427 * hardware and the PC. Expand that here before
428 * submitting it over the session bus --
429 * whatever is listening on the bus will be
430 * expecting a full 32-bit sample, based on
431 * the number of channels.
434 memset(devc->tmp_sample, 0, 4);
435 for (i = 0; i < 4; i++) {
436 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
438 * This channel group was
439 * enabled, copy from received
442 devc->tmp_sample[i] = devc->sample[j++];
443 } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
444 /* group 2 & 3 get added to 0 & 1 */
445 devc->tmp_sample[i - 2] = devc->sample[j++];
448 memcpy(devc->sample, devc->tmp_sample, 4);
449 sr_spew("Expanded sample: 0x%.8x.", sample);
453 * the OLS sends its sample buffer backwards.
454 * store it in reverse order here, so we can dump
455 * this on the session bus later.
457 offset = (devc->limit_samples - devc->num_samples) * 4;
458 for (i = 0; i <= devc->rle_count; i++) {
459 memcpy(devc->raw_sample_buf + offset + (i * 4),
462 memset(devc->sample, 0, 4);
468 * This is the main loop telling us a timeout was reached, or
469 * we've acquired all the samples we asked for -- we're done.
470 * Send the (properly-ordered) buffer to the frontend.
472 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
473 devc->cnt_bytes, devc->cnt_samples,
474 devc->cnt_samples_rle);
475 if (devc->trigger_at != -1) {
477 * A trigger was set up, so we need to tell the frontend
480 if (devc->trigger_at > 0) {
481 /* There are pre-trigger samples, send those first. */
482 packet.type = SR_DF_LOGIC;
483 packet.payload = &logic;
484 logic.length = devc->trigger_at * 4;
486 logic.data = devc->raw_sample_buf +
487 (devc->limit_samples - devc->num_samples) * 4;
488 sr_session_send(cb_data, &packet);
491 /* Send the trigger. */
492 packet.type = SR_DF_TRIGGER;
493 sr_session_send(cb_data, &packet);
495 /* Send post-trigger samples. */
496 packet.type = SR_DF_LOGIC;
497 packet.payload = &logic;
498 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
500 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
501 (devc->limit_samples - devc->num_samples) * 4;
502 sr_session_send(cb_data, &packet);
504 /* no trigger was used */
505 packet.type = SR_DF_LOGIC;
506 packet.payload = &logic;
507 logic.length = devc->num_samples * 4;
509 logic.data = devc->raw_sample_buf +
510 (devc->limit_samples - devc->num_samples) * 4;
511 sr_session_send(cb_data, &packet);
513 g_free(devc->raw_sample_buf);
515 serial_flush(serial);
516 abort_acquisition(sdi);