]> sigrok.org Git - libsigrok.git/blame_incremental - hardware/openbench-logic-sniffer/api.c
asix-sigma: Use std_dev_clear().
[libsigrok.git] / hardware / openbench-logic-sniffer / api.c
... / ...
CommitLineData
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
22#define SERIALCOMM "115200/8n1"
23
24static const int32_t hwopts[] = {
25 SR_CONF_CONN,
26 SR_CONF_SERIALCOMM,
27};
28
29static const int32_t hwcaps[] = {
30 SR_CONF_LOGIC_ANALYZER,
31 SR_CONF_SAMPLERATE,
32 SR_CONF_TRIGGER_TYPE,
33 SR_CONF_CAPTURE_RATIO,
34 SR_CONF_LIMIT_SAMPLES,
35 SR_CONF_RLE,
36};
37
38/* Probes are numbered 0-31 (on the PCB silkscreen). */
39SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
40 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
41 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
42 "24", "25", "26", "27", "28", "29", "30", "31",
43 NULL,
44};
45
46/* Default supported samplerates, can be overridden by device metadata. */
47static const uint64_t samplerates[] = {
48 SR_HZ(10),
49 SR_MHZ(200),
50 SR_HZ(1),
51};
52
53SR_PRIV struct sr_dev_driver ols_driver_info;
54static struct sr_dev_driver *di = &ols_driver_info;
55
56static int init(struct sr_context *sr_ctx)
57{
58 return std_hw_init(sr_ctx, di, LOG_PREFIX);
59}
60
61static GSList *scan(GSList *options)
62{
63 struct sr_config *src;
64 struct sr_dev_inst *sdi;
65 struct drv_context *drvc;
66 struct dev_context *devc;
67 struct sr_probe *probe;
68 struct sr_serial_dev_inst *serial;
69 GPollFD probefd;
70 GSList *l, *devices;
71 int ret, i;
72 const char *conn, *serialcomm;
73 char buf[8];
74
75 drvc = di->priv;
76
77 devices = NULL;
78
79 conn = serialcomm = NULL;
80 for (l = options; l; l = l->next) {
81 src = l->data;
82 switch (src->key) {
83 case SR_CONF_CONN:
84 conn = g_variant_get_string(src->data, NULL);
85 break;
86 case SR_CONF_SERIALCOMM:
87 serialcomm = g_variant_get_string(src->data, NULL);
88 break;
89 }
90 }
91 if (!conn)
92 return NULL;
93
94 if (serialcomm == NULL)
95 serialcomm = SERIALCOMM;
96
97 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
98 return NULL;
99
100 /* The discovery procedure is like this: first send the Reset
101 * command (0x00) 5 times, since the device could be anywhere
102 * in a 5-byte command. Then send the ID command (0x02).
103 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
104 * have a match.
105 */
106 sr_info("Probing %s.", conn);
107 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
108 return NULL;
109
110 ret = SR_OK;
111 for (i = 0; i < 5; i++) {
112 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
113 sr_err("Port %s is not writable.", conn);
114 break;
115 }
116 }
117 if (ret != SR_OK) {
118 serial_close(serial);
119 sr_err("Could not use port %s. Quitting.", conn);
120 return NULL;
121 }
122 send_shortcommand(serial, CMD_ID);
123
124 /* Wait 10ms for a response. */
125 g_usleep(10000);
126
127 probefd.fd = serial->fd;
128 probefd.events = G_IO_IN;
129 g_poll(&probefd, 1, 1);
130
131 if (probefd.revents != G_IO_IN)
132 return NULL;
133 if (serial_read(serial, buf, 4) != 4)
134 return NULL;
135 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
136 return NULL;
137
138 /* Definitely using the OLS protocol, check if it supports
139 * the metadata command.
140 */
141 send_shortcommand(serial, CMD_METADATA);
142 if (g_poll(&probefd, 1, 10) > 0) {
143 /* Got metadata. */
144 sdi = get_metadata(serial);
145 sdi->index = 0;
146 devc = sdi->priv;
147 } else {
148 /* Not an OLS -- some other board that uses the sump protocol. */
149 sr_info("Device does not support metadata.");
150 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
151 "Sump", "Logic Analyzer", "v1.0");
152 sdi->driver = di;
153 for (i = 0; i < 32; i++) {
154 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
155 ols_probe_names[i])))
156 return 0;
157 sdi->probes = g_slist_append(sdi->probes, probe);
158 }
159 devc = ols_dev_new();
160 sdi->priv = devc;
161 }
162 /* Configure samplerate and divider. */
163 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
164 sr_dbg("Failed to set default samplerate (%"PRIu64").",
165 DEFAULT_SAMPLERATE);
166 /* Clear trigger masks, values and stages. */
167 ols_configure_probes(sdi);
168 sdi->inst_type = SR_INST_SERIAL;
169 sdi->conn = serial;
170
171 drvc->instances = g_slist_append(drvc->instances, sdi);
172 devices = g_slist_append(devices, sdi);
173
174 serial_close(serial);
175
176 return devices;
177}
178
179static GSList *dev_list(void)
180{
181 return ((struct drv_context *)(di->priv))->instances;
182}
183
184static int dev_open(struct sr_dev_inst *sdi)
185{
186 struct sr_serial_dev_inst *serial;
187
188 serial = sdi->conn;
189 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
190 return SR_ERR;
191
192 sdi->status = SR_ST_ACTIVE;
193
194 return SR_OK;
195}
196
197static int dev_close(struct sr_dev_inst *sdi)
198{
199 struct sr_serial_dev_inst *serial;
200
201 serial = sdi->conn;
202 if (serial && serial->fd != -1) {
203 serial_close(serial);
204 sdi->status = SR_ST_INACTIVE;
205 }
206
207 return SR_OK;
208}
209
210static int dev_clear(void)
211{
212 return std_dev_clear(di, NULL);
213}
214
215static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
216{
217 struct dev_context *devc;
218
219 if (!sdi)
220 return SR_ERR_ARG;
221
222 devc = sdi->priv;
223 switch (id) {
224 case SR_CONF_SAMPLERATE:
225 *data = g_variant_new_uint64(devc->cur_samplerate);
226 break;
227 case SR_CONF_CAPTURE_RATIO:
228 *data = g_variant_new_uint64(devc->capture_ratio);
229 break;
230 case SR_CONF_LIMIT_SAMPLES:
231 *data = g_variant_new_uint64(devc->limit_samples);
232 break;
233 case SR_CONF_RLE:
234 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
235 break;
236 default:
237 return SR_ERR_NA;
238 }
239
240 return SR_OK;
241}
242
243static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
244{
245 struct dev_context *devc;
246 int ret;
247 uint64_t tmp_u64;
248
249 if (sdi->status != SR_ST_ACTIVE)
250 return SR_ERR_DEV_CLOSED;
251
252 devc = sdi->priv;
253
254 switch (id) {
255 case SR_CONF_SAMPLERATE:
256 tmp_u64 = g_variant_get_uint64(data);
257 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
258 return SR_ERR_SAMPLERATE;
259 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
260 break;
261 case SR_CONF_LIMIT_SAMPLES:
262 tmp_u64 = g_variant_get_uint64(data);
263 if (tmp_u64 < MIN_NUM_SAMPLES)
264 return SR_ERR;
265 devc->limit_samples = tmp_u64;
266 ret = SR_OK;
267 break;
268 case SR_CONF_CAPTURE_RATIO:
269 devc->capture_ratio = g_variant_get_uint64(data);
270 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
271 devc->capture_ratio = 0;
272 ret = SR_ERR;
273 } else
274 ret = SR_OK;
275 break;
276 case SR_CONF_RLE:
277 if (g_variant_get_boolean(data)) {
278 sr_info("Enabling RLE.");
279 devc->flag_reg |= FLAG_RLE;
280 } else {
281 sr_info("Disabling RLE.");
282 devc->flag_reg &= ~FLAG_RLE;
283 }
284 ret = SR_OK;
285 break;
286 default:
287 ret = SR_ERR_NA;
288 }
289
290 return ret;
291}
292
293static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
294{
295 GVariant *gvar;
296 GVariantBuilder gvb;
297
298 (void)sdi;
299
300 switch (key) {
301 case SR_CONF_SCAN_OPTIONS:
302 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
303 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
304 break;
305 case SR_CONF_DEVICE_OPTIONS:
306 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
307 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
308 break;
309 case SR_CONF_SAMPLERATE:
310 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
311 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
312 ARRAY_SIZE(samplerates), sizeof(uint64_t));
313 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
314 *data = g_variant_builder_end(&gvb);
315 break;
316 case SR_CONF_TRIGGER_TYPE:
317 *data = g_variant_new_string(TRIGGER_TYPE);
318 break;
319 default:
320 return SR_ERR_NA;
321 }
322
323 return SR_OK;
324}
325
326static int dev_acquisition_start(const struct sr_dev_inst *sdi,
327 void *cb_data)
328{
329 struct dev_context *devc;
330 struct sr_serial_dev_inst *serial;
331 uint32_t trigger_config[4];
332 uint32_t data;
333 uint16_t readcount, delaycount;
334 uint8_t changrp_mask;
335 int num_channels;
336 int i;
337
338 if (sdi->status != SR_ST_ACTIVE)
339 return SR_ERR_DEV_CLOSED;
340
341 devc = sdi->priv;
342 serial = sdi->conn;
343
344 if (ols_configure_probes(sdi) != SR_OK) {
345 sr_err("Failed to configure probes.");
346 return SR_ERR;
347 }
348
349 /*
350 * Enable/disable channel groups in the flag register according to the
351 * probe mask. Calculate this here, because num_channels is needed
352 * to limit readcount.
353 */
354 changrp_mask = 0;
355 num_channels = 0;
356 for (i = 0; i < 4; i++) {
357 if (devc->probe_mask & (0xff << (i * 8))) {
358 changrp_mask |= (1 << i);
359 num_channels++;
360 }
361 }
362
363 /*
364 * Limit readcount to prevent reading past the end of the hardware
365 * buffer.
366 */
367 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
368
369 memset(trigger_config, 0, 16);
370 trigger_config[devc->num_stages] |= 0x08;
371 if (devc->trigger_mask[0]) {
372 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
373 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
374
375 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
376 reverse32(devc->trigger_mask[0])) != SR_OK)
377 return SR_ERR;
378 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
379 reverse32(devc->trigger_value[0])) != SR_OK)
380 return SR_ERR;
381 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
382 trigger_config[0]) != SR_OK)
383 return SR_ERR;
384
385 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_1,
386 reverse32(devc->trigger_mask[1])) != SR_OK)
387 return SR_ERR;
388 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_1,
389 reverse32(devc->trigger_value[1])) != SR_OK)
390 return SR_ERR;
391 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_1,
392 trigger_config[1]) != SR_OK)
393 return SR_ERR;
394
395 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_2,
396 reverse32(devc->trigger_mask[2])) != SR_OK)
397 return SR_ERR;
398 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_2,
399 reverse32(devc->trigger_value[2])) != SR_OK)
400 return SR_ERR;
401 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_2,
402 trigger_config[2]) != SR_OK)
403 return SR_ERR;
404
405 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_3,
406 reverse32(devc->trigger_mask[3])) != SR_OK)
407 return SR_ERR;
408 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_3,
409 reverse32(devc->trigger_value[3])) != SR_OK)
410 return SR_ERR;
411 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_3,
412 trigger_config[3]) != SR_OK)
413 return SR_ERR;
414 } else {
415 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
416 devc->trigger_mask[0]) != SR_OK)
417 return SR_ERR;
418 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
419 devc->trigger_value[0]) != SR_OK)
420 return SR_ERR;
421 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
422 0x00000008) != SR_OK)
423 return SR_ERR;
424 delaycount = readcount;
425 }
426
427 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
428 "demux %s)", devc->cur_samplerate, devc->cur_samplerate_divider,
429 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
430 if (send_longcommand(serial, CMD_SET_DIVIDER,
431 reverse32(devc->cur_samplerate_divider)) != SR_OK)
432 return SR_ERR;
433
434 /* Send sample limit and pre/post-trigger capture ratio. */
435 data = ((readcount - 1) & 0xffff) << 16;
436 data |= (delaycount - 1) & 0xffff;
437 if (send_longcommand(serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
438 return SR_ERR;
439
440 /* The flag register wants them here, and 1 means "disable channel". */
441 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
442 devc->flag_reg |= FLAG_FILTER;
443 devc->rle_count = 0;
444 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
445 if (send_longcommand(serial, CMD_SET_FLAGS, data) != SR_OK)
446 return SR_ERR;
447
448 /* Start acquisition on the device. */
449 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
450 return SR_ERR;
451
452 /* Reset all operational states. */
453 devc->num_transfers = devc->num_samples = devc->num_bytes = 0;
454
455 /* Send header packet to the session bus. */
456 std_session_send_df_header(cb_data, LOG_PREFIX);
457
458 sr_source_add(serial->fd, G_IO_IN, -1, ols_receive_data, cb_data);
459
460 return SR_OK;
461}
462
463static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
464{
465 (void)cb_data;
466
467 abort_acquisition(sdi);
468
469 return SR_OK;
470}
471
472SR_PRIV struct sr_dev_driver ols_driver_info = {
473 .name = "ols",
474 .longname = "Openbench Logic Sniffer",
475 .api_version = 1,
476 .init = init,
477 .cleanup = dev_clear,
478 .scan = scan,
479 .dev_list = dev_list,
480 .dev_clear = dev_clear,
481 .config_get = config_get,
482 .config_set = config_set,
483 .config_list = config_list,
484 .dev_open = dev_open,
485 .dev_close = dev_close,
486 .dev_acquisition_start = dev_acquisition_start,
487 .dev_acquisition_stop = dev_acquisition_stop,
488 .priv = NULL,
489};