]> sigrok.org Git - libsigrok.git/blame - hardware/openbench-logic-sniffer/ols.c
Hardware drivers: Use names for struct entries.
[libsigrok.git] / hardware / openbench-logic-sniffer / ols.c
CommitLineData
a1bb33af
UH
1/*
2 * This file is part of the sigrok project.
3 *
4 * Copyright (C) 2010 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 <stdio.h>
21#include <stdint.h>
22#include <stdlib.h>
23#include <sys/types.h>
24#include <sys/stat.h>
25#include <fcntl.h>
26#include <unistd.h>
a9f54bcd
UH
27#ifdef _WIN32
28#include <windows.h>
29#else
a1bb33af 30#include <termios.h>
926b866c 31#endif
a1bb33af
UH
32#include <string.h>
33#include <sys/time.h>
34#include <inttypes.h>
926b866c
UH
35#ifdef _WIN32
36/* TODO */
37#else
6937bb75 38#include <arpa/inet.h>
926b866c 39#endif
a1bb33af 40#include <glib.h>
43fc7885 41#include <sigrok.h>
1483577e 42#include <sigrok-internal.h>
4fe9a6da 43#include "ols.h"
a1bb33af 44
1fdb75e1
UH
45#ifdef _WIN32
46#define O_NONBLOCK FIONBIO
47#endif
48
a1bb33af 49static int capabilities[] = {
5a2326a7
UH
50 SR_HWCAP_LOGIC_ANALYZER,
51 SR_HWCAP_SAMPLERATE,
52 SR_HWCAP_CAPTURE_RATIO,
53 SR_HWCAP_LIMIT_SAMPLES,
43fc7885 54 0,
a1bb33af
UH
55};
56
4fe9a6da 57/* default supported samplerates, can be overridden by device metadata */
60679b18 58static struct sr_samplerates samplerates = {
c9140419 59 SR_HZ(10),
59df0c77 60 SR_MHZ(200),
c9140419
UH
61 SR_HZ(1),
62 NULL,
a1bb33af
UH
63};
64
6c290072 65/* List of struct sr_serial_device_instance */
a1bb33af
UH
66static GSList *device_instances = NULL;
67
6937bb75 68static int send_shortcommand(int fd, uint8_t command)
a1bb33af
UH
69{
70 char buf[1];
71
b08024a8 72 sr_dbg("ols: sending cmd 0x%.2x", command);
a1bb33af 73 buf[0] = command;
2119ab03 74 if (serial_write(fd, buf, 1) != 1)
e46b8fb1 75 return SR_ERR;
a1bb33af 76
e46b8fb1 77 return SR_OK;
a1bb33af
UH
78}
79
6937bb75 80static int send_longcommand(int fd, uint8_t command, uint32_t data)
a1bb33af
UH
81{
82 char buf[5];
83
b08024a8 84 sr_dbg("ols: sending cmd 0x%.2x data 0x%.8x", command, data);
a1bb33af 85 buf[0] = command;
6937bb75
BV
86 buf[1] = (data & 0xff000000) >> 24;
87 buf[2] = (data & 0xff0000) >> 16;
88 buf[3] = (data & 0xff00) >> 8;
89 buf[4] = data & 0xff;
2119ab03 90 if (serial_write(fd, buf, 5) != 5)
e46b8fb1 91 return SR_ERR;
a1bb33af 92
e46b8fb1 93 return SR_OK;
a1bb33af
UH
94}
95
4fe9a6da 96static int configure_probes(struct ols_device *ols, GSList *probes)
a1bb33af 97{
1afe8989 98 struct sr_probe *probe;
a1bb33af 99 GSList *l;
6937bb75 100 int probe_bit, stage, i;
a1bb33af
UH
101 char *tc;
102
4fe9a6da 103 ols->probe_mask = 0;
43fc7885 104 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
4fe9a6da
BV
105 ols->trigger_mask[i] = 0;
106 ols->trigger_value[i] = 0;
a1bb33af
UH
107 }
108
4fe9a6da 109 ols->num_stages = 0;
43fc7885 110 for (l = probes; l; l = l->next) {
1afe8989 111 probe = (struct sr_probe *)l->data;
43fc7885 112 if (!probe->enabled)
6937bb75
BV
113 continue;
114
43fc7885
UH
115 /*
116 * Set up the probe mask for later configuration into the
117 * flag register.
118 */
a1bb33af 119 probe_bit = 1 << (probe->index - 1);
4fe9a6da 120 ols->probe_mask |= probe_bit;
6937bb75 121
a803c0db 122 if (!probe->trigger)
6937bb75
BV
123 continue;
124
43fc7885 125 /* Configure trigger mask and value. */
6937bb75 126 stage = 0;
43fc7885 127 for (tc = probe->trigger; tc && *tc; tc++) {
4fe9a6da 128 ols->trigger_mask[stage] |= probe_bit;
43fc7885 129 if (*tc == '1')
4fe9a6da 130 ols->trigger_value[stage] |= probe_bit;
6937bb75 131 stage++;
43fc7885
UH
132 if (stage > 3)
133 /*
134 * TODO: Only supporting parallel mode, with
135 * up to 4 stages.
136 */
e46b8fb1 137 return SR_ERR;
a1bb33af 138 }
4fe9a6da
BV
139 if (stage > ols->num_stages)
140 ols->num_stages = stage;
a1bb33af
UH
141 }
142
e46b8fb1 143 return SR_OK;
a1bb33af
UH
144}
145
a803c0db 146static uint32_t reverse16(uint32_t in)
6937bb75
BV
147{
148 uint32_t out;
149
a803c0db
BV
150 out = (in & 0xff) << 8;
151 out |= (in & 0xff00) >> 8;
152 out |= (in & 0xff0000) << 8;
153 out |= (in & 0xff000000) >> 8;
154
155 return out;
156}
157
158static uint32_t reverse32(uint32_t in)
159{
160 uint32_t out;
161
162 out = (in & 0xff) << 24;
163 out |= (in & 0xff00) << 8;
164 out |= (in & 0xff0000) >> 8;
165 out |= (in & 0xff000000) >> 24;
166
167 return out;
6937bb75
BV
168}
169
4fe9a6da
BV
170static struct ols_device *ols_device_new(void)
171{
172 struct ols_device *ols;
173
c0a4b971 174 /* TODO: Is 'ols' ever g_free()'d? */
b53738ba
UH
175 if (!(ols = g_try_malloc0(sizeof(struct ols_device)))) {
176 sr_err("ols: %s: ols malloc failed", __func__);
177 return NULL;
178 }
179
4fe9a6da
BV
180 ols->trigger_at = -1;
181 ols->probe_mask = 0xffffffff;
182 ols->cur_samplerate = SR_KHZ(200);
183
184 return ols;
185}
186
187static struct sr_device_instance *get_metadata(int fd)
188{
189 struct sr_device_instance *sdi;
190 struct ols_device *ols;
191 uint32_t tmp_int;
192 uint8_t key, type, token;
193 GString *tmp_str, *devicename, *version;
194 gchar tmp_c;
195
196 sdi = sr_device_instance_new(0, SR_ST_INACTIVE, NULL, NULL, NULL);
197 ols = ols_device_new();
198 sdi->priv = ols;
199
200 devicename = g_string_new("");
201 version = g_string_new("");
202
203 key = 0xff;
204 while (key) {
205 if (serial_read(fd, &key, 1) != 1 || key == 0x00)
206 break;
207 type = key >> 5;
208 token = key & 0x1f;
209 switch (type) {
210 case 0:
211 /* NULL-terminated string */
212 tmp_str = g_string_new("");
213 while (serial_read(fd, &tmp_c, 1) == 1 && tmp_c != '\0')
214 g_string_append_c(tmp_str, tmp_c);
b08024a8
UH
215 sr_dbg("ols: got metadata key 0x%.2x value '%s'",
216 key, tmp_str->str);
4fe9a6da
BV
217 switch (token) {
218 case 0x01:
219 /* Device name */
220 devicename = g_string_append(devicename, tmp_str->str);
221 break;
222 case 0x02:
223 /* FPGA firmware version */
224 if (version->len)
225 g_string_append(version, ", ");
226 g_string_append(version, "FPGA version ");
227 g_string_append(version, tmp_str->str);
228 break;
229 case 0x03:
230 /* Ancillary version */
231 if (version->len)
232 g_string_append(version, ", ");
233 g_string_append(version, "Ancillary version ");
234 g_string_append(version, tmp_str->str);
235 break;
236 default:
b08024a8
UH
237 sr_info("ols: unknown token 0x%.2x: '%s'",
238 token, tmp_str->str);
4fe9a6da
BV
239 break;
240 }
241 g_string_free(tmp_str, TRUE);
242 break;
243 case 1:
244 /* 32-bit unsigned integer */
245 if (serial_read(fd, &tmp_int, 4) != 4)
246 break;
247 tmp_int = reverse32(tmp_int);
b08024a8
UH
248 sr_dbg("ols: got metadata key 0x%.2x value 0x%.8x",
249 key, tmp_int);
4fe9a6da
BV
250 switch (token) {
251 case 0x00:
252 /* Number of usable probes */
253 ols->num_probes = tmp_int;
254 break;
255 case 0x01:
256 /* Amount of sample memory available (bytes) */
257 ols->max_samples = tmp_int;
258 break;
259 case 0x02:
260 /* Amount of dynamic memory available (bytes) */
261 /* what is this for? */
262 break;
263 case 0x03:
264 /* Maximum sample rate (hz) */
265 ols->max_samplerate = tmp_int;
266 break;
267 case 0x04:
268 /* protocol version */
269 ols->protocol_version = tmp_int;
270 break;
271 default:
b08024a8
UH
272 sr_info("ols: unknown token 0x%.2x: 0x%.8x",
273 token, tmp_int);
4fe9a6da
BV
274 break;
275 }
276 break;
277 case 2:
278 /* 8-bit unsigned integer */
279 if (serial_read(fd, &tmp_c, 1) != 1)
280 break;
b08024a8
UH
281 sr_dbg("ols: got metadata key 0x%.2x value 0x%.2x",
282 key, tmp_c);
4fe9a6da
BV
283 switch (token) {
284 case 0x00:
285 /* Number of usable probes */
286 ols->num_probes = tmp_c;
287 break;
288 case 0x01:
289 /* protocol version */
290 ols->protocol_version = tmp_c;
291 break;
292 default:
b08024a8
UH
293 sr_info("ols: unknown token 0x%.2x: 0x%.2x",
294 token, tmp_c);
4fe9a6da
BV
295 break;
296 }
297 break;
298 default:
299 /* unknown type */
300 break;
301 }
302 }
303
304 sdi->model = devicename->str;
305 sdi->version = version->str;
306 g_string_free(devicename, FALSE);
307 g_string_free(version, FALSE);
308
309 return sdi;
310}
311
54ac5277 312static int hw_init(const char *deviceinfo)
a1bb33af 313{
a00ba012 314 struct sr_device_instance *sdi;
4fe9a6da 315 struct ols_device *ols;
a1bb33af 316 GSList *ports, *l;
4fe9a6da 317 GPollFD *fds, probefd;
6937bb75 318 int devcnt, final_devcnt, num_ports, fd, ret, i;
d02a535e 319 char buf[8], **device_names, **serial_params;
a1bb33af 320
c0a4b971
UH
321 final_devcnt = 0;
322
43fc7885 323 if (deviceinfo)
6937bb75 324 ports = g_slist_append(NULL, strdup(deviceinfo));
a1bb33af 325 else
43fc7885 326 /* No specific device given, so scan all serial ports. */
a1bb33af
UH
327 ports = list_serial_ports();
328
329 num_ports = g_slist_length(ports);
c0a4b971
UH
330
331 if (!(fds = g_try_malloc0(num_ports * sizeof(GPollFD)))) {
332 sr_err("ols: %s: fds malloc failed", __func__);
333 goto hw_init_free_ports; /* TODO: SR_ERR_MALLOC. */
334 }
335
336 if (!(device_names = g_try_malloc(num_ports * sizeof(char *)))) {
337 sr_err("ols: %s: device_names malloc failed", __func__);
338 goto hw_init_free_fds; /* TODO: SR_ERR_MALLOC. */
339 }
340
341 if (!(serial_params = g_try_malloc(num_ports * sizeof(char *)))) {
342 sr_err("ols: %s: serial_params malloc failed", __func__);
343 goto hw_init_free_device_names; /* TODO: SR_ERR_MALLOC. */
344 }
345
a1bb33af 346 devcnt = 0;
43fc7885
UH
347 for (l = ports; l; l = l->next) {
348 /* The discovery procedure is like this: first send the Reset
349 * command (0x00) 5 times, since the device could be anywhere
350 * in a 5-byte command. Then send the ID command (0x02).
351 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
352 * have a match.
353 *
354 * Since it may take the device a while to respond at 115Kb/s,
355 * we do all the sending first, then wait for all of them to
356 * respond with g_poll().
a1bb33af 357 */
b08024a8 358 sr_info("ols: probing %s...", (char *)l->data);
d02a535e 359 fd = serial_open(l->data, O_RDWR | O_NONBLOCK);
43fc7885 360 if (fd != -1) {
d02a535e
BV
361 serial_params[devcnt] = serial_backup_params(fd);
362 serial_set_params(fd, 115200, 8, 0, 1, 2);
e46b8fb1 363 ret = SR_OK;
43fc7885
UH
364 for (i = 0; i < 5; i++) {
365 if ((ret = send_shortcommand(fd,
e46b8fb1 366 CMD_RESET)) != SR_OK) {
43fc7885 367 /* Serial port is not writable. */
6937bb75
BV
368 break;
369 }
a1bb33af 370 }
e46b8fb1 371 if (ret != SR_OK) {
43fc7885
UH
372 serial_restore_params(fd,
373 serial_params[devcnt]);
d02a535e 374 serial_close(fd);
6937bb75 375 continue;
d02a535e 376 }
6937bb75
BV
377 send_shortcommand(fd, CMD_ID);
378 fds[devcnt].fd = fd;
379 fds[devcnt].events = G_IO_IN;
380 device_names[devcnt] = strdup(l->data);
381 devcnt++;
a1bb33af 382 }
6937bb75 383 free(l->data);
a1bb33af
UH
384 }
385
5b15b41e
PS
386 /* 2ms isn't enough for reliable transfer with pl2303, let's try 10 */
387 usleep(10000);
a1bb33af 388
a1bb33af 389 g_poll(fds, devcnt, 1);
4fe9a6da 390
43fc7885 391 for (i = 0; i < devcnt; i++) {
4fe9a6da
BV
392 if (fds[i].revents != G_IO_IN)
393 continue;
394 if (serial_read(fds[i].fd, buf, 4) != 4)
395 continue;
396 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
397 continue;
398
399 /* definitely using the OLS protocol, check if it supports
400 * the metadata command
401 */
402 send_shortcommand(fds[i].fd, CMD_METADATA);
403 probefd.fd = fds[i].fd;
404 probefd.events = G_IO_IN;
405 if (g_poll(&probefd, 1, 10) > 0) {
406 /* got metadata */
407 sdi = get_metadata(fds[i].fd);
408 sdi->index = final_devcnt;
409 } else {
410 /* not an OLS -- some other board that uses the sump protocol */
411 sdi = sr_device_instance_new(final_devcnt, SR_ST_INACTIVE,
412 "Sump", "Logic Analyzer", "v1.0");
413 ols = ols_device_new();
414 ols->num_probes = 32;
415 sdi->priv = ols;
a1bb33af 416 }
4fe9a6da
BV
417 sdi->serial = sr_serial_device_instance_new(device_names[i], -1);
418 device_instances = g_slist_append(device_instances, sdi);
419 final_devcnt++;
420 serial_close(fds[i].fd);
421 fds[i].fd = 0;
4fe9a6da
BV
422 }
423
424 /* clean up after all the probing */
425 for (i = 0; i < devcnt; i++) {
43fc7885 426 if (fds[i].fd != 0) {
d02a535e
BV
427 serial_restore_params(fds[i].fd, serial_params[i]);
428 serial_close(fds[i].fd);
6937bb75 429 }
d02a535e 430 free(serial_params[i]);
4fe9a6da 431 free(device_names[i]);
a1bb33af
UH
432 }
433
c0a4b971
UH
434hw_init_free_serial_params:
435 g_free(serial_params);
436hw_init_free_device_names:
437 g_free(device_names);
438hw_init_free_fds:
439 g_free(fds);
440hw_init_free_ports:
a1bb33af
UH
441 g_slist_free(ports);
442
443 return final_devcnt;
444}
445
a1bb33af
UH
446static int hw_opendev(int device_index)
447{
a00ba012 448 struct sr_device_instance *sdi;
a1bb33af 449
d32d961d 450 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
e46b8fb1 451 return SR_ERR;
a1bb33af 452
d02a535e 453 sdi->serial->fd = serial_open(sdi->serial->port, O_RDWR);
43fc7885 454 if (sdi->serial->fd == -1)
e46b8fb1 455 return SR_ERR;
a1bb33af 456
5a2326a7 457 sdi->status = SR_ST_ACTIVE;
a1bb33af 458
e46b8fb1 459 return SR_OK;
a1bb33af
UH
460}
461
a1bb33af
UH
462static void hw_closedev(int device_index)
463{
a00ba012 464 struct sr_device_instance *sdi;
a1bb33af 465
d32d961d 466 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
a1bb33af
UH
467 return;
468
43fc7885 469 if (sdi->serial->fd != -1) {
d02a535e 470 serial_close(sdi->serial->fd);
a1bb33af 471 sdi->serial->fd = -1;
5a2326a7 472 sdi->status = SR_ST_INACTIVE;
a1bb33af 473 }
a1bb33af
UH
474}
475
a1bb33af
UH
476static void hw_cleanup(void)
477{
478 GSList *l;
a00ba012 479 struct sr_device_instance *sdi;
a1bb33af 480
43fc7885
UH
481 /* Properly close all devices. */
482 for (l = device_instances; l; l = l->next) {
a1bb33af 483 sdi = l->data;
43fc7885 484 if (sdi->serial->fd != -1)
d02a535e 485 serial_close(sdi->serial->fd);
a00ba012 486 sr_device_instance_free(sdi);
a1bb33af
UH
487 }
488 g_slist_free(device_instances);
489 device_instances = NULL;
a1bb33af
UH
490}
491
a1bb33af
UH
492static void *hw_get_device_info(int device_index, int device_info_id)
493{
a00ba012 494 struct sr_device_instance *sdi;
4fe9a6da 495 struct ols_device *ols;
a1bb33af
UH
496 void *info;
497
d32d961d 498 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
a1bb33af 499 return NULL;
4fe9a6da 500 ols = sdi->priv;
a1bb33af
UH
501
502 info = NULL;
43fc7885 503 switch (device_info_id) {
5a2326a7 504 case SR_DI_INSTANCE:
a1bb33af
UH
505 info = sdi;
506 break;
5a2326a7 507 case SR_DI_NUM_PROBES:
a1bb33af
UH
508 info = GINT_TO_POINTER(NUM_PROBES);
509 break;
5a2326a7 510 case SR_DI_SAMPLERATES:
a1bb33af
UH
511 info = &samplerates;
512 break;
5a2326a7 513 case SR_DI_TRIGGER_TYPES:
43fc7885 514 info = (char *)TRIGGER_TYPES;
a1bb33af 515 break;
5a2326a7 516 case SR_DI_CUR_SAMPLERATE:
4fe9a6da 517 info = &ols->cur_samplerate;
a1bb33af
UH
518 break;
519 }
520
521 return info;
522}
523
a1bb33af
UH
524static int hw_get_status(int device_index)
525{
a00ba012 526 struct sr_device_instance *sdi;
a1bb33af 527
d32d961d 528 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
5a2326a7 529 return SR_ST_NOT_FOUND;
a1bb33af
UH
530
531 return sdi->status;
532}
533
a1bb33af
UH
534static int *hw_get_capabilities(void)
535{
a1bb33af
UH
536 return capabilities;
537}
538
a00ba012 539static int set_configuration_samplerate(struct sr_device_instance *sdi,
43fc7885 540 uint64_t samplerate)
a1bb33af 541{
4fe9a6da 542 struct ols_device *ols;
a1bb33af 543
4fe9a6da
BV
544 ols = sdi->priv;
545 if (ols->max_samplerate) {
546 if (samplerate > ols->max_samplerate)
547 return SR_ERR_SAMPLERATE;
548 } else if (samplerate < samplerates.low || samplerate > samplerates.high)
e46b8fb1 549 return SR_ERR_SAMPLERATE;
a1bb33af 550
4fe9a6da 551 ols->cur_samplerate = samplerate;
43fc7885 552 if (samplerate > CLOCK_RATE) {
4fe9a6da
BV
553 ols->flag_reg |= FLAG_DEMUX;
554 ols->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1;
43fc7885 555 } else {
4fe9a6da
BV
556 ols->flag_reg &= ~FLAG_DEMUX;
557 ols->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1;
a1bb33af 558 }
a1bb33af 559
e46b8fb1 560 return SR_OK;
a1bb33af
UH
561}
562
a1bb33af
UH
563static int hw_set_configuration(int device_index, int capability, void *value)
564{
a00ba012 565 struct sr_device_instance *sdi;
4fe9a6da 566 struct ols_device *ols;
a1bb33af
UH
567 int ret;
568 uint64_t *tmp_u64;
569
d32d961d 570 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
e46b8fb1 571 return SR_ERR;
4fe9a6da 572 ols = sdi->priv;
a1bb33af 573
5a2326a7 574 if (sdi->status != SR_ST_ACTIVE)
e46b8fb1 575 return SR_ERR;
a1bb33af 576
a803c0db 577 switch (capability) {
5a2326a7 578 case SR_HWCAP_SAMPLERATE:
a1bb33af
UH
579 tmp_u64 = value;
580 ret = set_configuration_samplerate(sdi, *tmp_u64);
a803c0db 581 break;
5a2326a7 582 case SR_HWCAP_PROBECONFIG:
4fe9a6da 583 ret = configure_probes(ols, (GSList *) value);
a803c0db 584 break;
5a2326a7 585 case SR_HWCAP_LIMIT_SAMPLES:
2458ea65 586 tmp_u64 = value;
574ce498 587 if (*tmp_u64 < MIN_NUM_SAMPLES)
e46b8fb1 588 return SR_ERR;
4fe9a6da 589 ols->limit_samples = *tmp_u64;
b08024a8 590 sr_info("ols: sample limit %" PRIu64, ols->limit_samples);
e46b8fb1 591 ret = SR_OK;
a803c0db 592 break;
5a2326a7 593 case SR_HWCAP_CAPTURE_RATIO:
a803c0db 594 tmp_u64 = value;
4fe9a6da
BV
595 ols->capture_ratio = *tmp_u64;
596 if (ols->capture_ratio < 0 || ols->capture_ratio > 100) {
597 ols->capture_ratio = 0;
e46b8fb1 598 ret = SR_ERR;
43fc7885 599 } else
e46b8fb1 600 ret = SR_OK;
a803c0db
BV
601 break;
602 default:
e46b8fb1 603 ret = SR_ERR;
43fc7885 604 }
a1bb33af
UH
605
606 return ret;
607}
608
a1bb33af
UH
609static int receive_data(int fd, int revents, void *user_data)
610{
b9c735a2 611 struct sr_datafeed_packet packet;
4fe9a6da
BV
612 struct sr_device_instance *sdi;
613 struct ols_device *ols;
614 GSList *l;
615 int count, buflen, num_channels, offset, i, j;
a1bb33af
UH
616 unsigned char byte, *buffer;
617
4fe9a6da
BV
618 /* find this device's ols_device struct by its fd */
619 ols = NULL;
620 for (l = device_instances; l; l = l->next) {
621 sdi = l->data;
622 if (sdi->serial->fd == fd) {
623 ols = sdi->priv;
624 break;
625 }
626 }
627 if (!ols)
628 /* shouldn't happen */
629 return TRUE;
630
631 if (ols->num_transfers++ == 0) {
43fc7885
UH
632 /*
633 * First time round, means the device started sending data,
634 * and will not stop until done. If it stops sending for
635 * longer than it takes to send a byte, that means it's
636 * finished. We'll double that to 30ms to be sure...
a1bb33af 637 */
6f1be0a2
UH
638 sr_source_remove(fd);
639 sr_source_add(fd, G_IO_IN, 30, receive_data, user_data);
c0a4b971
UH
640 ols->raw_sample_buf = g_try_malloc(ols->limit_samples * 4);
641 if (!ols->raw_sample_buf) {
642 sr_err("ols: %s: ols->raw_sample_buf malloc failed",
643 __func__);
644 return FALSE;
645 }
a803c0db 646 /* fill with 1010... for debugging */
4fe9a6da 647 memset(ols->raw_sample_buf, 0x82, ols->limit_samples * 4);
a1bb33af
UH
648 }
649
6937bb75 650 num_channels = 0;
43fc7885 651 for (i = 0x20; i > 0x02; i /= 2) {
4fe9a6da 652 if ((ols->flag_reg & i) == 0)
6937bb75 653 num_channels++;
43fc7885 654 }
6937bb75 655
43fc7885 656 if (revents == G_IO_IN
4fe9a6da 657 && ols->num_transfers / num_channels <= ols->limit_samples) {
2119ab03 658 if (serial_read(fd, &byte, 1) != 1)
a1bb33af
UH
659 return FALSE;
660
4fe9a6da 661 ols->sample[ols->num_bytes++] = byte;
b08024a8 662 sr_dbg("ols: received byte 0x%.2x", byte);
4fe9a6da 663 if (ols->num_bytes == num_channels) {
43fc7885 664 /* Got a full sample. */
b08024a8
UH
665 sr_dbg("ols: received sample 0x%.*x",
666 ols->num_bytes * 2, (int) *ols->sample);
4fe9a6da 667 if (ols->flag_reg & FLAG_RLE) {
43fc7885
UH
668 /*
669 * In RLE mode -1 should never come in as a
670 * sample, because bit 31 is the "count" flag.
671 * TODO: Endianness may be wrong here, could be
672 * sample[3].
673 */
4fe9a6da
BV
674 if (ols->sample[0] & 0x80
675 && !(ols->last_sample[0] & 0x80)) {
676 count = (int)(*ols->sample) & 0x7fffffff;
b53738ba
UH
677 if (!(buffer = g_try_malloc(count))) {
678 sr_err("ols: %s: buffer malloc "
679 "failed", __func__);
680 return FALSE;
681 }
682
a1bb33af 683 buflen = 0;
43fc7885 684 for (i = 0; i < count; i++) {
4fe9a6da 685 memcpy(buffer + buflen, ols->last_sample, 4);
a1bb33af
UH
686 buflen += 4;
687 }
43fc7885
UH
688 } else {
689 /*
690 * Just a single sample, next sample
691 * will probably be a count referring
692 * to this -- but this one is still a
693 * part of the stream.
a1bb33af 694 */
4fe9a6da 695 buffer = ols->sample;
a1bb33af
UH
696 buflen = 4;
697 }
43fc7885
UH
698 } else {
699 /* No compression. */
4fe9a6da 700 buffer = ols->sample;
a1bb33af
UH
701 buflen = 4;
702 }
703
43fc7885
UH
704 if (num_channels < 4) {
705 /*
706 * Some channel groups may have been turned
707 * off, to speed up transfer between the
708 * hardware and the PC. Expand that here before
709 * submitting it over the session bus --
710 * whatever is listening on the bus will be
711 * expecting a full 32-bit sample, based on
712 * the number of probes.
6937bb75
BV
713 */
714 j = 0;
4fe9a6da 715 memset(ols->tmp_sample, 0, 4);
43fc7885 716 for (i = 0; i < 4; i++) {
4fe9a6da 717 if (((ols->flag_reg >> 2) & (1 << i)) == 0) {
43fc7885
UH
718 /*
719 * This channel group was
720 * enabled, copy from received
721 * sample.
722 */
4fe9a6da 723 ols->tmp_sample[i] = ols->sample[j++];
6937bb75
BV
724 }
725 }
4fe9a6da 726 memcpy(ols->sample, ols->tmp_sample, 4);
b08024a8 727 sr_dbg("ols: full sample 0x%.8x", (int) *ols->sample);
6937bb75
BV
728 }
729
a803c0db
BV
730 /* the OLS sends its sample buffer backwards.
731 * store it in reverse order here, so we can dump
732 * this on the session bus later.
733 */
4fe9a6da
BV
734 offset = (ols->limit_samples - ols->num_transfers / num_channels) * 4;
735 memcpy(ols->raw_sample_buf + offset, ols->sample, 4);
a803c0db 736
4fe9a6da
BV
737 if (buffer == ols->sample)
738 memcpy(ols->last_sample, buffer, num_channels);
a1bb33af
UH
739 else
740 g_free(buffer);
741
4fe9a6da
BV
742 memset(ols->sample, 0, 4);
743 ols->num_bytes = 0;
a1bb33af 744 }
43fc7885
UH
745 } else {
746 /*
747 * This is the main loop telling us a timeout was reached, or
748 * we've acquired all the samples we asked for -- we're done.
a803c0db 749 * Send the (properly-ordered) buffer to the frontend.
43fc7885 750 */
4fe9a6da 751 if (ols->trigger_at != -1) {
a803c0db
BV
752 /* a trigger was set up, so we need to tell the frontend
753 * about it.
754 */
4fe9a6da 755 if (ols->trigger_at > 0) {
a803c0db 756 /* there are pre-trigger samples, send those first */
5a2326a7 757 packet.type = SR_DF_LOGIC;
4fe9a6da 758 packet.length = ols->trigger_at * 4;
4c046c6b 759 packet.unitsize = 4;
4fe9a6da 760 packet.payload = ols->raw_sample_buf;
8a2efef2 761 sr_session_bus(user_data, &packet);
a803c0db
BV
762 }
763
5a2326a7 764 packet.type = SR_DF_TRIGGER;
a803c0db 765 packet.length = 0;
8a2efef2 766 sr_session_bus(user_data, &packet);
a803c0db 767
5a2326a7 768 packet.type = SR_DF_LOGIC;
4fe9a6da 769 packet.length = (ols->limit_samples * 4) - (ols->trigger_at * 4);
4c046c6b 770 packet.unitsize = 4;
4fe9a6da 771 packet.payload = ols->raw_sample_buf + ols->trigger_at * 4;
8a2efef2 772 sr_session_bus(user_data, &packet);
a803c0db 773 } else {
5a2326a7 774 packet.type = SR_DF_LOGIC;
4fe9a6da 775 packet.length = ols->limit_samples * 4;
4c046c6b 776 packet.unitsize = 4;
4fe9a6da 777 packet.payload = ols->raw_sample_buf;
8a2efef2 778 sr_session_bus(user_data, &packet);
a803c0db 779 }
c0a4b971 780 g_free(ols->raw_sample_buf);
a803c0db 781
06d64eb8 782 serial_flush(fd);
d02a535e 783 serial_close(fd);
5a2326a7 784 packet.type = SR_DF_END;
a1bb33af 785 packet.length = 0;
8a2efef2 786 sr_session_bus(user_data, &packet);
a1bb33af
UH
787 }
788
789 return TRUE;
790}
791
a1bb33af
UH
792static int hw_start_acquisition(int device_index, gpointer session_device_id)
793{
b9c735a2
UH
794 struct sr_datafeed_packet *packet;
795 struct sr_datafeed_header *header;
a00ba012 796 struct sr_device_instance *sdi;
4fe9a6da 797 struct ols_device *ols;
a803c0db 798 uint32_t trigger_config[4];
a1bb33af 799 uint32_t data;
6937bb75
BV
800 uint16_t readcount, delaycount;
801 uint8_t changrp_mask;
4fe9a6da 802 int i;
a1bb33af 803
d32d961d 804 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
e46b8fb1 805 return SR_ERR;
c0a4b971 806
4fe9a6da 807 ols = sdi->priv;
a1bb33af 808
5a2326a7 809 if (sdi->status != SR_ST_ACTIVE)
e46b8fb1 810 return SR_ERR;
a1bb33af 811
4fe9a6da 812 readcount = ols->limit_samples / 4;
a803c0db
BV
813
814 memset(trigger_config, 0, 16);
4fe9a6da
BV
815 trigger_config[ols->num_stages - 1] |= 0x08;
816 if (ols->trigger_mask[0]) {
817 delaycount = readcount * (1 - ols->capture_ratio / 100.0);
818 ols->trigger_at = (readcount - delaycount) * 4 - ols->num_stages;
a803c0db 819
43fc7885 820 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_0,
4fe9a6da 821 reverse32(ols->trigger_mask[0])) != SR_OK)
e46b8fb1 822 return SR_ERR;
a803c0db 823 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_0,
4fe9a6da 824 reverse32(ols->trigger_value[0])) != SR_OK)
e46b8fb1 825 return SR_ERR;
a803c0db 826 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
e46b8fb1
UH
827 trigger_config[0]) != SR_OK)
828 return SR_ERR;
6937bb75 829
a803c0db 830 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_1,
4fe9a6da 831 reverse32(ols->trigger_mask[1])) != SR_OK)
e46b8fb1 832 return SR_ERR;
43fc7885 833 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_1,
4fe9a6da 834 reverse32(ols->trigger_value[1])) != SR_OK)
e46b8fb1 835 return SR_ERR;
a803c0db 836 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_1,
e46b8fb1
UH
837 trigger_config[1]) != SR_OK)
838 return SR_ERR;
6937bb75 839
a803c0db 840 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_2,
4fe9a6da 841 reverse32(ols->trigger_mask[2])) != SR_OK)
e46b8fb1 842 return SR_ERR;
a803c0db 843 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_2,
4fe9a6da 844 reverse32(ols->trigger_value[2])) != SR_OK)
e46b8fb1 845 return SR_ERR;
43fc7885 846 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_2,
e46b8fb1
UH
847 trigger_config[2]) != SR_OK)
848 return SR_ERR;
a803c0db
BV
849
850 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_3,
4fe9a6da 851 reverse32(ols->trigger_mask[3])) != SR_OK)
e46b8fb1 852 return SR_ERR;
a803c0db 853 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_3,
4fe9a6da 854 reverse32(ols->trigger_value[3])) != SR_OK)
e46b8fb1 855 return SR_ERR;
43fc7885 856 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_3,
e46b8fb1
UH
857 trigger_config[3]) != SR_OK)
858 return SR_ERR;
6937bb75 859 } else {
43fc7885 860 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_0,
4fe9a6da 861 ols->trigger_mask[0]) != SR_OK)
e46b8fb1 862 return SR_ERR;
43fc7885 863 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_0,
4fe9a6da 864 ols->trigger_value[0]) != SR_OK)
e46b8fb1 865 return SR_ERR;
43fc7885 866 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
e46b8fb1
UH
867 0x00000008) != SR_OK)
868 return SR_ERR;
a803c0db 869 delaycount = readcount;
6937bb75 870 }
a1bb33af 871
b08024a8
UH
872 sr_info("ols: setting samplerate to %" PRIu64 " Hz (divider %u, "
873 "demux %s)", ols->cur_samplerate, ols->cur_samplerate_divider,
874 ols->flag_reg & FLAG_DEMUX ? "on" : "off");
4fe9a6da
BV
875 if (send_longcommand(sdi->serial->fd, CMD_SET_DIVIDER,
876 reverse32(ols->cur_samplerate_divider)) != SR_OK)
877 return SR_ERR;
a1bb33af 878
43fc7885 879 /* Send sample limit and pre/post-trigger capture ratio. */
a803c0db
BV
880 data = ((readcount - 1) & 0xffff) << 16;
881 data |= (delaycount - 1) & 0xffff;
e46b8fb1
UH
882 if (send_longcommand(sdi->serial->fd, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
883 return SR_ERR;
a1bb33af 884
43fc7885
UH
885 /*
886 * Enable/disable channel groups in the flag register according to the
a803c0db 887 * probe mask.
6937bb75
BV
888 */
889 changrp_mask = 0;
43fc7885 890 for (i = 0; i < 4; i++) {
4fe9a6da 891 if (ols->probe_mask & (0xff << (i * 8)))
a803c0db 892 changrp_mask |= (1 << i);
6937bb75 893 }
43fc7885
UH
894
895 /* The flag register wants them here, and 1 means "disable channel". */
4fe9a6da
BV
896 ols->flag_reg |= ~(changrp_mask << 2) & 0x3c;
897 ols->flag_reg |= FLAG_FILTER;
898 data = ols->flag_reg << 24;
e46b8fb1
UH
899 if (send_longcommand(sdi->serial->fd, CMD_SET_FLAGS, data) != SR_OK)
900 return SR_ERR;
a1bb33af 901
43fc7885 902 /* Start acquisition on the device. */
e46b8fb1
UH
903 if (send_shortcommand(sdi->serial->fd, CMD_RUN) != SR_OK)
904 return SR_ERR;
a1bb33af 905
6f1be0a2
UH
906 sr_source_add(sdi->serial->fd, G_IO_IN, -1, receive_data,
907 session_device_id);
a1bb33af 908
b53738ba
UH
909 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
910 sr_err("ols: %s: packet malloc failed", __func__);
911 return SR_ERR_MALLOC;
912 }
913
914 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
915 sr_err("ols: %s: header malloc failed", __func__);
c0a4b971 916 g_free(packet);
b53738ba
UH
917 return SR_ERR_MALLOC;
918 }
919
43fc7885 920 /* Send header packet to the session bus. */
5a2326a7 921 packet->type = SR_DF_HEADER;
b9c735a2 922 packet->length = sizeof(struct sr_datafeed_header);
43fc7885 923 packet->payload = (unsigned char *)header;
a1bb33af
UH
924 header->feed_version = 1;
925 gettimeofday(&header->starttime, NULL);
4fe9a6da 926 header->samplerate = ols->cur_samplerate;
5a2326a7 927 header->protocol_id = SR_PROTO_RAW;
c2616fb9
DR
928 header->num_logic_probes = NUM_PROBES;
929 header->num_analog_probes = 0;
8a2efef2 930 sr_session_bus(session_device_id, packet);
c0a4b971 931
a1bb33af
UH
932 g_free(header);
933 g_free(packet);
934
e46b8fb1 935 return SR_OK;
a1bb33af
UH
936}
937
a1bb33af
UH
938static void hw_stop_acquisition(int device_index, gpointer session_device_id)
939{
b9c735a2 940 struct sr_datafeed_packet packet;
a1bb33af 941
17e1afcb 942 /* Avoid compiler warnings. */
afc8e4de
UH
943 device_index = device_index;
944
5a2326a7 945 packet.type = SR_DF_END;
a1bb33af 946 packet.length = 0;
8a2efef2 947 sr_session_bus(session_device_id, &packet);
a1bb33af
UH
948}
949
5c2d46d1 950struct sr_device_plugin ols_plugin_info = {
e519ba86
UH
951 .name = "ols",
952 .longname = "Openbench Logic Sniffer",
953 .api_version = 1,
954 .init = hw_init,
955 .cleanup = hw_cleanup,
956 .open = hw_opendev,
957 .close = hw_closedev,
958 .get_device_info = hw_get_device_info,
959 .get_status = hw_get_status,
960 .get_capabilities = hw_get_capabilities,
961 .set_configuration = hw_set_configuration,
962 .start_acquisition = hw_start_acquisition,
963 .stop_acquisition = hw_stop_acquisition,
a1bb33af 964};