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