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) != 1)
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) != 5)
57 /* Configures the channel mask based on which channels are enabled. */
58 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi)
60 struct dev_context *devc;
61 struct sr_channel *channel;
66 devc->channel_mask = 0;
67 for (l = sdi->channels; l; l = l->next) {
70 devc->channel_mask |= 1 << channel->index;
74 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
76 struct dev_context *devc;
77 struct sr_trigger *trigger;
78 struct sr_trigger_stage *stage;
79 struct sr_trigger_match *match;
86 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
87 devc->trigger_mask[i] = 0;
88 devc->trigger_value[i] = 0;
91 if (!(trigger = sr_session_trigger_get()))
94 devc->num_stages = g_slist_length(trigger->stages);
95 if (devc->num_stages > NUM_TRIGGER_STAGES) {
96 sr_err("This device only supports %d trigger stages.",
101 for (l = trigger->stages; l; l = l->next) {
103 for (m = stage->matches; m; m = m->next) {
105 if (!match->channel->enabled)
106 /* Ignore disabled channels with a trigger. */
108 devc->trigger_mask[stage->stage] |= 1 << match->channel->index;
109 if (match->match == SR_TRIGGER_ONE)
110 devc->trigger_value[stage->stage] |= 1 << match->channel->index;
117 SR_PRIV struct dev_context *ols_dev_new(void)
119 struct dev_context *devc;
121 if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
122 sr_err("Device context malloc failed.");
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 struct sr_channel *ch;
143 uint32_t tmp_int, ui;
144 uint8_t key, type, token;
145 GString *tmp_str, *devname, *version;
148 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, NULL, NULL, NULL);
150 devc = ols_dev_new();
153 devname = g_string_new("");
154 version = g_string_new("");
158 if (serial_read_blocking(serial, &key, 1) != 1)
161 sr_dbg("Got metadata key 0x00, metadata ends.");
168 /* NULL-terminated string */
169 tmp_str = g_string_new("");
170 while (serial_read_blocking(serial, &tmp_c, 1) == 1 && tmp_c != '\0')
171 g_string_append_c(tmp_str, tmp_c);
172 sr_dbg("Got metadata key 0x%.2x value '%s'.",
177 devname = g_string_append(devname, tmp_str->str);
180 /* FPGA firmware version */
182 g_string_append(version, ", ");
183 g_string_append(version, "FPGA version ");
184 g_string_append(version, tmp_str->str);
187 /* Ancillary version */
189 g_string_append(version, ", ");
190 g_string_append(version, "Ancillary version ");
191 g_string_append(version, tmp_str->str);
194 sr_info("ols: unknown token 0x%.2x: '%s'",
195 token, tmp_str->str);
198 g_string_free(tmp_str, TRUE);
201 /* 32-bit unsigned integer */
202 if (serial_read_blocking(serial, &tmp_int, 4) != 4)
204 tmp_int = RB32(&tmp_int);
205 sr_dbg("Got metadata key 0x%.2x value 0x%.8x.",
209 /* Number of usable channels */
210 for (ui = 0; ui < tmp_int; ui++) {
211 if (!(ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE,
212 ols_channel_names[ui])))
214 sdi->channels = g_slist_append(sdi->channels, ch);
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 if (serial_read_blocking(serial, &tmp_c, 1) != 1)
243 sr_dbg("Got metadata key 0x%.2x value 0x%.2x.",
247 /* Number of usable channels */
248 for (ui = 0; ui < tmp_c; ui++) {
249 if (!(ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE,
250 ols_channel_names[ui])))
252 sdi->channels = g_slist_append(sdi->channels, ch);
256 /* protocol version */
257 devc->protocol_version = tmp_c;
260 sr_info("Unknown token 0x%.2x: 0x%.2x.",
271 sdi->model = devname->str;
272 sdi->version = version->str;
273 g_string_free(devname, FALSE);
274 g_string_free(version, FALSE);
279 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
280 const uint64_t samplerate)
282 struct dev_context *devc;
285 if (devc->max_samplerate && samplerate > devc->max_samplerate)
286 return SR_ERR_SAMPLERATE;
288 if (samplerate > CLOCK_RATE) {
289 sr_info("Enabling demux mode.");
290 devc->flag_reg |= FLAG_DEMUX;
291 devc->flag_reg &= ~FLAG_FILTER;
292 devc->max_channels = NUM_CHANNELS / 2;
293 devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
295 sr_info("Disabling demux mode.");
296 devc->flag_reg &= ~FLAG_DEMUX;
297 devc->flag_reg |= FLAG_FILTER;
298 devc->max_channels = NUM_CHANNELS;
299 devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
302 /* Calculate actual samplerate used and complain if it is different
303 * from the requested.
305 devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1);
306 if (devc->flag_reg & FLAG_DEMUX)
307 devc->cur_samplerate *= 2;
308 if (devc->cur_samplerate != samplerate)
309 sr_info("Can't match samplerate %" PRIu64 ", using %"
310 PRIu64 ".", samplerate, devc->cur_samplerate);
315 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi)
317 struct sr_datafeed_packet packet;
318 struct sr_serial_dev_inst *serial;
321 serial_source_remove(serial);
323 /* Terminate session */
324 packet.type = SR_DF_END;
325 sr_session_send(sdi, &packet);
328 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data)
330 struct dev_context *devc;
331 struct sr_dev_inst *sdi;
332 struct sr_serial_dev_inst *serial;
333 struct sr_datafeed_packet packet;
334 struct sr_datafeed_logic logic;
336 int num_ols_changrp, offset, j;
346 if (devc->num_transfers++ == 0) {
348 * First time round, means the device started sending data,
349 * and will not stop until done. If it stops sending for
350 * longer than it takes to send a byte, that means it's
351 * finished. We'll double that to 30ms to be sure...
353 serial_source_remove(serial);
354 serial_source_add(serial, G_IO_IN, 30, ols_receive_data, cb_data);
355 devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4);
356 if (!devc->raw_sample_buf) {
357 sr_err("Sample buffer malloc failed.");
360 /* fill with 1010... for debugging */
361 memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4);
365 for (i = NUM_CHANNELS; i > 0x02; i /= 2) {
366 if ((devc->flag_reg & i) == 0) {
371 if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) {
372 if (serial_read_nonblocking(serial, &byte, 1) != 1)
376 /* Ignore it if we've read enough. */
377 if (devc->num_samples >= devc->limit_samples)
380 devc->sample[devc->num_bytes++] = byte;
381 sr_spew("Received byte 0x%.2x.", byte);
382 if (devc->num_bytes == num_ols_changrp) {
384 devc->cnt_samples_rle++;
386 * Got a full sample. Convert from the OLS's little-endian
387 * sample to the local format.
389 sample = devc->sample[0] | (devc->sample[1] << 8) \
390 | (devc->sample[2] << 16) | (devc->sample[3] << 24);
391 sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample);
392 if (devc->flag_reg & FLAG_RLE) {
394 * In RLE mode the high bit of the sample is the
395 * "count" flag, meaning this sample is the number
396 * of times the previous sample occurred.
398 if (devc->sample[devc->num_bytes - 1] & 0x80) {
399 /* Clear the high bit. */
400 sample &= ~(0x80 << (devc->num_bytes - 1) * 8);
401 devc->rle_count = sample;
402 devc->cnt_samples_rle += devc->rle_count;
403 sr_dbg("RLE count: %u.", devc->rle_count);
408 devc->num_samples += devc->rle_count + 1;
409 if (devc->num_samples > devc->limit_samples) {
410 /* Save us from overrunning the buffer. */
411 devc->rle_count -= devc->num_samples - devc->limit_samples;
412 devc->num_samples = devc->limit_samples;
415 if (num_ols_changrp < 4) {
417 * Some channel groups may have been turned
418 * off, to speed up transfer between the
419 * hardware and the PC. Expand that here before
420 * submitting it over the session bus --
421 * whatever is listening on the bus will be
422 * expecting a full 32-bit sample, based on
423 * the number of channels.
426 memset(devc->tmp_sample, 0, 4);
427 for (i = 0; i < 4; i++) {
428 if (((devc->flag_reg >> 2) & (1 << i)) == 0) {
430 * This channel group was
431 * enabled, copy from received
434 devc->tmp_sample[i] = devc->sample[j++];
435 } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) {
436 /* group 2 & 3 get added to 0 & 1 */
437 devc->tmp_sample[i - 2] = devc->sample[j++];
440 memcpy(devc->sample, devc->tmp_sample, 4);
441 sr_spew("Expanded sample: 0x%.8x.", sample);
445 * the OLS sends its sample buffer backwards.
446 * store it in reverse order here, so we can dump
447 * this on the session bus later.
449 offset = (devc->limit_samples - devc->num_samples) * 4;
450 for (i = 0; i <= devc->rle_count; i++) {
451 memcpy(devc->raw_sample_buf + offset + (i * 4),
454 memset(devc->sample, 0, 4);
460 * This is the main loop telling us a timeout was reached, or
461 * we've acquired all the samples we asked for -- we're done.
462 * Send the (properly-ordered) buffer to the frontend.
464 sr_dbg("Received %d bytes, %d samples, %d decompressed samples.",
465 devc->cnt_bytes, devc->cnt_samples,
466 devc->cnt_samples_rle);
467 if (devc->trigger_at != -1) {
469 * A trigger was set up, so we need to tell the frontend
472 if (devc->trigger_at > 0) {
473 /* There are pre-trigger samples, send those first. */
474 packet.type = SR_DF_LOGIC;
475 packet.payload = &logic;
476 logic.length = devc->trigger_at * 4;
478 logic.data = devc->raw_sample_buf +
479 (devc->limit_samples - devc->num_samples) * 4;
480 sr_session_send(cb_data, &packet);
483 /* Send the trigger. */
484 packet.type = SR_DF_TRIGGER;
485 sr_session_send(cb_data, &packet);
487 /* Send post-trigger samples. */
488 packet.type = SR_DF_LOGIC;
489 packet.payload = &logic;
490 logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4);
492 logic.data = devc->raw_sample_buf + devc->trigger_at * 4 +
493 (devc->limit_samples - devc->num_samples) * 4;
494 sr_session_send(cb_data, &packet);
496 /* no trigger was used */
497 packet.type = SR_DF_LOGIC;
498 packet.payload = &logic;
499 logic.length = devc->num_samples * 4;
501 logic.data = devc->raw_sample_buf +
502 (devc->limit_samples - devc->num_samples) * 4;
503 sr_session_send(cb_data, &packet);
505 g_free(devc->raw_sample_buf);
507 serial_flush(serial);
508 abort_acquisition(sdi);