]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
20 | #include "protocol.h" | |
21 | #include <libserialport.h> | |
22 | ||
23 | extern SR_PRIV struct sr_dev_driver ols_driver_info; | |
24 | static struct sr_dev_driver *di = &ols_driver_info; | |
25 | ||
26 | SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial, | |
27 | uint8_t command) | |
28 | { | |
29 | char buf[1]; | |
30 | ||
31 | sr_dbg("Sending cmd 0x%.2x.", command); | |
32 | buf[0] = command; | |
33 | if (serial_write_blocking(serial, buf, 1, serial_timeout(serial, 1)) != 1) | |
34 | return SR_ERR; | |
35 | ||
36 | if (serial_drain(serial) != 0) | |
37 | return SR_ERR; | |
38 | ||
39 | return SR_OK; | |
40 | } | |
41 | ||
42 | SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial, | |
43 | uint8_t command, uint8_t *data) | |
44 | { | |
45 | char buf[5]; | |
46 | ||
47 | sr_dbg("Sending cmd 0x%.2x data 0x%.2x%.2x%.2x%.2x.", command, | |
48 | data[0], data[1], data[2], data[3]); | |
49 | buf[0] = command; | |
50 | buf[1] = data[0]; | |
51 | buf[2] = data[1]; | |
52 | buf[3] = data[2]; | |
53 | buf[4] = data[3]; | |
54 | if (serial_write_blocking(serial, buf, 5, serial_timeout(serial, 1)) != 5) | |
55 | return SR_ERR; | |
56 | ||
57 | if (serial_drain(serial) != 0) | |
58 | return SR_ERR; | |
59 | ||
60 | return SR_OK; | |
61 | } | |
62 | ||
63 | /* Configures the channel mask based on which channels are enabled. */ | |
64 | SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi) | |
65 | { | |
66 | struct dev_context *devc; | |
67 | struct sr_channel *channel; | |
68 | const GSList *l; | |
69 | ||
70 | devc = sdi->priv; | |
71 | ||
72 | devc->channel_mask = 0; | |
73 | for (l = sdi->channels; l; l = l->next) { | |
74 | channel = l->data; | |
75 | if (channel->enabled) | |
76 | devc->channel_mask |= 1 << channel->index; | |
77 | } | |
78 | } | |
79 | ||
80 | SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi) | |
81 | { | |
82 | struct dev_context *devc; | |
83 | struct sr_trigger *trigger; | |
84 | struct sr_trigger_stage *stage; | |
85 | struct sr_trigger_match *match; | |
86 | const GSList *l, *m; | |
87 | int i; | |
88 | ||
89 | devc = sdi->priv; | |
90 | ||
91 | devc->num_stages = 0; | |
92 | for (i = 0; i < NUM_TRIGGER_STAGES; i++) { | |
93 | devc->trigger_mask[i] = 0; | |
94 | devc->trigger_value[i] = 0; | |
95 | } | |
96 | ||
97 | if (!(trigger = sr_session_trigger_get(sdi->session))) | |
98 | return SR_OK; | |
99 | ||
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.", | |
103 | NUM_TRIGGER_STAGES); | |
104 | return SR_ERR; | |
105 | } | |
106 | ||
107 | for (l = trigger->stages; l; l = l->next) { | |
108 | stage = l->data; | |
109 | for (m = stage->matches; m; m = m->next) { | |
110 | match = m->data; | |
111 | if (!match->channel->enabled) | |
112 | /* Ignore disabled channels with a trigger. */ | |
113 | continue; | |
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; | |
117 | } | |
118 | } | |
119 | ||
120 | return SR_OK; | |
121 | } | |
122 | ||
123 | SR_PRIV struct dev_context *ols_dev_new(void) | |
124 | { | |
125 | struct dev_context *devc; | |
126 | ||
127 | if (!(devc = g_try_malloc(sizeof(struct dev_context)))) { | |
128 | sr_err("Device context malloc failed."); | |
129 | return NULL; | |
130 | } | |
131 | ||
132 | /* Device-specific settings */ | |
133 | devc->max_samples = devc->max_samplerate = devc->protocol_version = 0; | |
134 | ||
135 | /* Acquisition settings */ | |
136 | devc->limit_samples = devc->capture_ratio = 0; | |
137 | devc->trigger_at = -1; | |
138 | devc->channel_mask = 0xffffffff; | |
139 | devc->flag_reg = 0; | |
140 | ||
141 | return devc; | |
142 | } | |
143 | ||
144 | SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial) | |
145 | { | |
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; | |
151 | int delay_ms; | |
152 | GString *tmp_str, *devname, *version; | |
153 | guchar tmp_c; | |
154 | ||
155 | sdi = sr_dev_inst_new(SR_ST_INACTIVE, NULL, NULL, NULL); | |
156 | sdi->driver = di; | |
157 | devc = ols_dev_new(); | |
158 | sdi->priv = devc; | |
159 | ||
160 | devname = g_string_new(""); | |
161 | version = g_string_new(""); | |
162 | ||
163 | key = 0xff; | |
164 | while (key) { | |
165 | delay_ms = serial_timeout(serial, 1); | |
166 | if (serial_read_blocking(serial, &key, 1, delay_ms) != 1) | |
167 | break; | |
168 | if (key == 0x00) { | |
169 | sr_dbg("Got metadata key 0x00, metadata ends."); | |
170 | break; | |
171 | } | |
172 | type = key >> 5; | |
173 | token = key & 0x1f; | |
174 | switch (type) { | |
175 | case 0: | |
176 | /* NULL-terminated string */ | |
177 | tmp_str = g_string_new(""); | |
178 | delay_ms = serial_timeout(serial, 1); | |
179 | while (serial_read_blocking(serial, &tmp_c, 1, delay_ms) == 1 && tmp_c != '\0') | |
180 | g_string_append_c(tmp_str, tmp_c); | |
181 | sr_dbg("Got metadata key 0x%.2x value '%s'.", | |
182 | key, tmp_str->str); | |
183 | switch (token) { | |
184 | case 0x01: | |
185 | /* Device name */ | |
186 | devname = g_string_append(devname, tmp_str->str); | |
187 | break; | |
188 | case 0x02: | |
189 | /* FPGA firmware version */ | |
190 | if (version->len) | |
191 | g_string_append(version, ", "); | |
192 | g_string_append(version, "FPGA version "); | |
193 | g_string_append(version, tmp_str->str); | |
194 | break; | |
195 | case 0x03: | |
196 | /* Ancillary version */ | |
197 | if (version->len) | |
198 | g_string_append(version, ", "); | |
199 | g_string_append(version, "Ancillary version "); | |
200 | g_string_append(version, tmp_str->str); | |
201 | break; | |
202 | default: | |
203 | sr_info("ols: unknown token 0x%.2x: '%s'", | |
204 | token, tmp_str->str); | |
205 | break; | |
206 | } | |
207 | g_string_free(tmp_str, TRUE); | |
208 | break; | |
209 | case 1: | |
210 | /* 32-bit unsigned integer */ | |
211 | delay_ms = serial_timeout(serial, 4); | |
212 | if (serial_read_blocking(serial, &tmp_int, 4, delay_ms) != 4) | |
213 | break; | |
214 | tmp_int = RB32(&tmp_int); | |
215 | sr_dbg("Got metadata key 0x%.2x value 0x%.8x.", | |
216 | key, tmp_int); | |
217 | switch (token) { | |
218 | case 0x00: | |
219 | /* Number of usable channels */ | |
220 | for (ui = 0; ui < tmp_int; ui++) { | |
221 | if (!(ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE, | |
222 | ols_channel_names[ui]))) | |
223 | return 0; | |
224 | sdi->channels = g_slist_append(sdi->channels, ch); | |
225 | } | |
226 | break; | |
227 | case 0x01: | |
228 | /* Amount of sample memory available (bytes) */ | |
229 | devc->max_samples = tmp_int; | |
230 | break; | |
231 | case 0x02: | |
232 | /* Amount of dynamic memory available (bytes) */ | |
233 | /* what is this for? */ | |
234 | break; | |
235 | case 0x03: | |
236 | /* Maximum sample rate (hz) */ | |
237 | devc->max_samplerate = tmp_int; | |
238 | break; | |
239 | case 0x04: | |
240 | /* protocol version */ | |
241 | devc->protocol_version = tmp_int; | |
242 | break; | |
243 | default: | |
244 | sr_info("Unknown token 0x%.2x: 0x%.8x.", | |
245 | token, tmp_int); | |
246 | break; | |
247 | } | |
248 | break; | |
249 | case 2: | |
250 | /* 8-bit unsigned integer */ | |
251 | delay_ms = serial_timeout(serial, 1); | |
252 | if (serial_read_blocking(serial, &tmp_c, 1, delay_ms) != 1) | |
253 | break; | |
254 | sr_dbg("Got metadata key 0x%.2x value 0x%.2x.", | |
255 | key, tmp_c); | |
256 | switch (token) { | |
257 | case 0x00: | |
258 | /* Number of usable channels */ | |
259 | for (ui = 0; ui < tmp_c; ui++) { | |
260 | if (!(ch = sr_channel_new(ui, SR_CHANNEL_LOGIC, TRUE, | |
261 | ols_channel_names[ui]))) | |
262 | return 0; | |
263 | sdi->channels = g_slist_append(sdi->channels, ch); | |
264 | } | |
265 | break; | |
266 | case 0x01: | |
267 | /* protocol version */ | |
268 | devc->protocol_version = tmp_c; | |
269 | break; | |
270 | default: | |
271 | sr_info("Unknown token 0x%.2x: 0x%.2x.", | |
272 | token, tmp_c); | |
273 | break; | |
274 | } | |
275 | break; | |
276 | default: | |
277 | /* unknown type */ | |
278 | break; | |
279 | } | |
280 | } | |
281 | ||
282 | sdi->model = devname->str; | |
283 | sdi->version = version->str; | |
284 | g_string_free(devname, FALSE); | |
285 | g_string_free(version, FALSE); | |
286 | ||
287 | return sdi; | |
288 | } | |
289 | ||
290 | SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi, | |
291 | const uint64_t samplerate) | |
292 | { | |
293 | struct dev_context *devc; | |
294 | ||
295 | devc = sdi->priv; | |
296 | if (devc->max_samplerate && samplerate > devc->max_samplerate) | |
297 | return SR_ERR_SAMPLERATE; | |
298 | ||
299 | if (samplerate > CLOCK_RATE) { | |
300 | sr_info("Enabling demux mode."); | |
301 | devc->flag_reg |= FLAG_DEMUX; | |
302 | devc->flag_reg &= ~FLAG_FILTER; | |
303 | devc->max_channels = NUM_CHANNELS / 2; | |
304 | devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1; | |
305 | } else { | |
306 | sr_info("Disabling demux mode."); | |
307 | devc->flag_reg &= ~FLAG_DEMUX; | |
308 | devc->flag_reg |= FLAG_FILTER; | |
309 | devc->max_channels = NUM_CHANNELS; | |
310 | devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1; | |
311 | } | |
312 | ||
313 | /* Calculate actual samplerate used and complain if it is different | |
314 | * from the requested. | |
315 | */ | |
316 | devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1); | |
317 | if (devc->flag_reg & FLAG_DEMUX) | |
318 | devc->cur_samplerate *= 2; | |
319 | if (devc->cur_samplerate != samplerate) | |
320 | sr_info("Can't match samplerate %" PRIu64 ", using %" | |
321 | PRIu64 ".", samplerate, devc->cur_samplerate); | |
322 | ||
323 | return SR_OK; | |
324 | } | |
325 | ||
326 | SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi) | |
327 | { | |
328 | struct sr_datafeed_packet packet; | |
329 | struct sr_serial_dev_inst *serial; | |
330 | ||
331 | serial = sdi->conn; | |
332 | serial_source_remove(sdi->session, serial); | |
333 | ||
334 | /* Terminate session */ | |
335 | packet.type = SR_DF_END; | |
336 | sr_session_send(sdi, &packet); | |
337 | } | |
338 | ||
339 | SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data) | |
340 | { | |
341 | struct dev_context *devc; | |
342 | struct sr_dev_inst *sdi; | |
343 | struct sr_serial_dev_inst *serial; | |
344 | struct sr_datafeed_packet packet; | |
345 | struct sr_datafeed_logic logic; | |
346 | uint32_t sample; | |
347 | int num_ols_changrp, offset, j; | |
348 | unsigned int i; | |
349 | unsigned char byte; | |
350 | ||
351 | (void)fd; | |
352 | ||
353 | sdi = cb_data; | |
354 | serial = sdi->conn; | |
355 | devc = sdi->priv; | |
356 | ||
357 | if (devc->num_transfers++ == 0) { | |
358 | /* | |
359 | * First time round, means the device started sending data, | |
360 | * and will not stop until done. If it stops sending for | |
361 | * longer than it takes to send a byte, that means it's | |
362 | * finished. We'll double that to 30ms to be sure... | |
363 | */ | |
364 | serial_source_remove(sdi->session, serial); | |
365 | serial_source_add(sdi->session, serial, G_IO_IN, 30, | |
366 | ols_receive_data, cb_data); | |
367 | devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4); | |
368 | if (!devc->raw_sample_buf) { | |
369 | sr_err("Sample buffer malloc failed."); | |
370 | return FALSE; | |
371 | } | |
372 | /* fill with 1010... for debugging */ | |
373 | memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4); | |
374 | } | |
375 | ||
376 | num_ols_changrp = 0; | |
377 | for (i = NUM_CHANNELS; i > 0x02; i /= 2) { | |
378 | if ((devc->flag_reg & i) == 0) { | |
379 | num_ols_changrp++; | |
380 | } | |
381 | } | |
382 | ||
383 | if (revents == G_IO_IN && devc->num_samples < devc->limit_samples) { | |
384 | if (serial_read_nonblocking(serial, &byte, 1) != 1) | |
385 | return FALSE; | |
386 | devc->cnt_bytes++; | |
387 | ||
388 | /* Ignore it if we've read enough. */ | |
389 | if (devc->num_samples >= devc->limit_samples) | |
390 | return TRUE; | |
391 | ||
392 | devc->sample[devc->num_bytes++] = byte; | |
393 | sr_spew("Received byte 0x%.2x.", byte); | |
394 | if (devc->num_bytes == num_ols_changrp) { | |
395 | devc->cnt_samples++; | |
396 | devc->cnt_samples_rle++; | |
397 | /* | |
398 | * Got a full sample. Convert from the OLS's little-endian | |
399 | * sample to the local format. | |
400 | */ | |
401 | sample = devc->sample[0] | (devc->sample[1] << 8) \ | |
402 | | (devc->sample[2] << 16) | (devc->sample[3] << 24); | |
403 | sr_dbg("Received sample 0x%.*x.", devc->num_bytes * 2, sample); | |
404 | if (devc->flag_reg & FLAG_RLE) { | |
405 | /* | |
406 | * In RLE mode the high bit of the sample is the | |
407 | * "count" flag, meaning this sample is the number | |
408 | * of times the previous sample occurred. | |
409 | */ | |
410 | if (devc->sample[devc->num_bytes - 1] & 0x80) { | |
411 | /* Clear the high bit. */ | |
412 | sample &= ~(0x80 << (devc->num_bytes - 1) * 8); | |
413 | devc->rle_count = sample; | |
414 | devc->cnt_samples_rle += devc->rle_count; | |
415 | sr_dbg("RLE count: %u.", devc->rle_count); | |
416 | devc->num_bytes = 0; | |
417 | return TRUE; | |
418 | } | |
419 | } | |
420 | devc->num_samples += devc->rle_count + 1; | |
421 | if (devc->num_samples > devc->limit_samples) { | |
422 | /* Save us from overrunning the buffer. */ | |
423 | devc->rle_count -= devc->num_samples - devc->limit_samples; | |
424 | devc->num_samples = devc->limit_samples; | |
425 | } | |
426 | ||
427 | if (num_ols_changrp < 4) { | |
428 | /* | |
429 | * Some channel groups may have been turned | |
430 | * off, to speed up transfer between the | |
431 | * hardware and the PC. Expand that here before | |
432 | * submitting it over the session bus -- | |
433 | * whatever is listening on the bus will be | |
434 | * expecting a full 32-bit sample, based on | |
435 | * the number of channels. | |
436 | */ | |
437 | j = 0; | |
438 | memset(devc->tmp_sample, 0, 4); | |
439 | for (i = 0; i < 4; i++) { | |
440 | if (((devc->flag_reg >> 2) & (1 << i)) == 0) { | |
441 | /* | |
442 | * This channel group was | |
443 | * enabled, copy from received | |
444 | * sample. | |
445 | */ | |
446 | devc->tmp_sample[i] = devc->sample[j++]; | |
447 | } else if (devc->flag_reg & FLAG_DEMUX && (i > 2)) { | |
448 | /* group 2 & 3 get added to 0 & 1 */ | |
449 | devc->tmp_sample[i - 2] = devc->sample[j++]; | |
450 | } | |
451 | } | |
452 | memcpy(devc->sample, devc->tmp_sample, 4); | |
453 | sr_spew("Expanded sample: 0x%.8x.", sample); | |
454 | } | |
455 | ||
456 | /* | |
457 | * the OLS sends its sample buffer backwards. | |
458 | * store it in reverse order here, so we can dump | |
459 | * this on the session bus later. | |
460 | */ | |
461 | offset = (devc->limit_samples - devc->num_samples) * 4; | |
462 | for (i = 0; i <= devc->rle_count; i++) { | |
463 | memcpy(devc->raw_sample_buf + offset + (i * 4), | |
464 | devc->sample, 4); | |
465 | } | |
466 | memset(devc->sample, 0, 4); | |
467 | devc->num_bytes = 0; | |
468 | devc->rle_count = 0; | |
469 | } | |
470 | } else { | |
471 | /* | |
472 | * This is the main loop telling us a timeout was reached, or | |
473 | * we've acquired all the samples we asked for -- we're done. | |
474 | * Send the (properly-ordered) buffer to the frontend. | |
475 | */ | |
476 | sr_dbg("Received %d bytes, %d samples, %d decompressed samples.", | |
477 | devc->cnt_bytes, devc->cnt_samples, | |
478 | devc->cnt_samples_rle); | |
479 | if (devc->trigger_at != -1) { | |
480 | /* | |
481 | * A trigger was set up, so we need to tell the frontend | |
482 | * about it. | |
483 | */ | |
484 | if (devc->trigger_at > 0) { | |
485 | /* There are pre-trigger samples, send those first. */ | |
486 | packet.type = SR_DF_LOGIC; | |
487 | packet.payload = &logic; | |
488 | logic.length = devc->trigger_at * 4; | |
489 | logic.unitsize = 4; | |
490 | logic.data = devc->raw_sample_buf + | |
491 | (devc->limit_samples - devc->num_samples) * 4; | |
492 | sr_session_send(cb_data, &packet); | |
493 | } | |
494 | ||
495 | /* Send the trigger. */ | |
496 | packet.type = SR_DF_TRIGGER; | |
497 | sr_session_send(cb_data, &packet); | |
498 | ||
499 | /* Send post-trigger samples. */ | |
500 | packet.type = SR_DF_LOGIC; | |
501 | packet.payload = &logic; | |
502 | logic.length = (devc->num_samples * 4) - (devc->trigger_at * 4); | |
503 | logic.unitsize = 4; | |
504 | logic.data = devc->raw_sample_buf + devc->trigger_at * 4 + | |
505 | (devc->limit_samples - devc->num_samples) * 4; | |
506 | sr_session_send(cb_data, &packet); | |
507 | } else { | |
508 | /* no trigger was used */ | |
509 | packet.type = SR_DF_LOGIC; | |
510 | packet.payload = &logic; | |
511 | logic.length = devc->num_samples * 4; | |
512 | logic.unitsize = 4; | |
513 | logic.data = devc->raw_sample_buf + | |
514 | (devc->limit_samples - devc->num_samples) * 4; | |
515 | sr_session_send(cb_data, &packet); | |
516 | } | |
517 | g_free(devc->raw_sample_buf); | |
518 | ||
519 | serial_flush(serial); | |
520 | abort_acquisition(sdi); | |
521 | } | |
522 | ||
523 | return TRUE; | |
524 | } |