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/>.
22 #define SERIALCOMM "115200/8n1"
24 static const int32_t hwopts[] = {
29 static const int32_t hwcaps[] = {
30 SR_CONF_LOGIC_ANALYZER,
33 SR_CONF_CAPTURE_RATIO,
34 SR_CONF_LIMIT_SAMPLES,
38 /* Probes are numbered 0-31 (on the PCB silkscreen). */
39 SR_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",
46 /* Default supported samplerates, can be overridden by device metadata. */
47 static const uint64_t samplerates[] = {
53 SR_PRIV struct sr_dev_driver ols_driver_info;
54 static struct sr_dev_driver *di = &ols_driver_info;
56 static int dev_clear(void)
58 return std_dev_clear(di, NULL);
61 static int init(struct sr_context *sr_ctx)
63 return std_init(sr_ctx, di, LOG_PREFIX);
66 static GSList *scan(GSList *options)
68 struct sr_config *src;
69 struct sr_dev_inst *sdi;
70 struct drv_context *drvc;
71 struct dev_context *devc;
72 struct sr_probe *probe;
73 struct sr_serial_dev_inst *serial;
77 const char *conn, *serialcomm;
84 conn = serialcomm = NULL;
85 for (l = options; l; l = l->next) {
89 conn = g_variant_get_string(src->data, NULL);
91 case SR_CONF_SERIALCOMM:
92 serialcomm = g_variant_get_string(src->data, NULL);
99 if (serialcomm == NULL)
100 serialcomm = SERIALCOMM;
102 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
105 /* The discovery procedure is like this: first send the Reset
106 * command (0x00) 5 times, since the device could be anywhere
107 * in a 5-byte command. Then send the ID command (0x02).
108 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
111 sr_info("Probing %s.", conn);
112 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
116 for (i = 0; i < 5; i++) {
117 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
118 sr_err("Port %s is not writable.", conn);
123 serial_close(serial);
124 sr_err("Could not use port %s. Quitting.", conn);
127 send_shortcommand(serial, CMD_ID);
129 /* Wait 10ms for a response. */
132 probefd.fd = serial->fd;
133 probefd.events = G_IO_IN;
134 g_poll(&probefd, 1, 1);
136 if (probefd.revents != G_IO_IN)
138 if (serial_read(serial, buf, 4) != 4)
140 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
143 /* Definitely using the OLS protocol, check if it supports
144 * the metadata command.
146 send_shortcommand(serial, CMD_METADATA);
147 if (g_poll(&probefd, 1, 10) > 0) {
149 sdi = get_metadata(serial);
153 /* Not an OLS -- some other board that uses the sump protocol. */
154 sr_info("Device does not support metadata.");
155 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
156 "Sump", "Logic Analyzer", "v1.0");
158 for (i = 0; i < 32; i++) {
159 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
160 ols_probe_names[i])))
162 sdi->probes = g_slist_append(sdi->probes, probe);
164 devc = ols_dev_new();
167 /* Configure samplerate and divider. */
168 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
169 sr_dbg("Failed to set default samplerate (%"PRIu64").",
171 /* Clear trigger masks, values and stages. */
172 ols_configure_probes(sdi);
173 sdi->inst_type = SR_INST_SERIAL;
176 drvc->instances = g_slist_append(drvc->instances, sdi);
177 devices = g_slist_append(devices, sdi);
179 serial_close(serial);
184 static GSList *dev_list(void)
186 return ((struct drv_context *)(di->priv))->instances;
189 static int dev_open(struct sr_dev_inst *sdi)
191 struct sr_serial_dev_inst *serial;
194 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
197 sdi->status = SR_ST_ACTIVE;
202 static int dev_close(struct sr_dev_inst *sdi)
204 struct sr_serial_dev_inst *serial;
207 if (serial && serial->fd != -1) {
208 serial_close(serial);
209 sdi->status = SR_ST_INACTIVE;
215 static int cleanup(void)
220 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
222 struct dev_context *devc;
229 case SR_CONF_SAMPLERATE:
230 *data = g_variant_new_uint64(devc->cur_samplerate);
232 case SR_CONF_CAPTURE_RATIO:
233 *data = g_variant_new_uint64(devc->capture_ratio);
235 case SR_CONF_LIMIT_SAMPLES:
236 *data = g_variant_new_uint64(devc->limit_samples);
239 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
248 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
250 struct dev_context *devc;
254 if (sdi->status != SR_ST_ACTIVE)
255 return SR_ERR_DEV_CLOSED;
260 case SR_CONF_SAMPLERATE:
261 tmp_u64 = g_variant_get_uint64(data);
262 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
263 return SR_ERR_SAMPLERATE;
264 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
266 case SR_CONF_LIMIT_SAMPLES:
267 tmp_u64 = g_variant_get_uint64(data);
268 if (tmp_u64 < MIN_NUM_SAMPLES)
270 devc->limit_samples = tmp_u64;
273 case SR_CONF_CAPTURE_RATIO:
274 devc->capture_ratio = g_variant_get_uint64(data);
275 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
276 devc->capture_ratio = 0;
282 if (g_variant_get_boolean(data)) {
283 sr_info("Enabling RLE.");
284 devc->flag_reg |= FLAG_RLE;
286 sr_info("Disabling RLE.");
287 devc->flag_reg &= ~FLAG_RLE;
298 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
306 case SR_CONF_SCAN_OPTIONS:
307 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
308 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
310 case SR_CONF_DEVICE_OPTIONS:
311 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
312 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
314 case SR_CONF_SAMPLERATE:
315 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
316 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
317 ARRAY_SIZE(samplerates), sizeof(uint64_t));
318 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
319 *data = g_variant_builder_end(&gvb);
321 case SR_CONF_TRIGGER_TYPE:
322 *data = g_variant_new_string(TRIGGER_TYPE);
331 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
334 struct dev_context *devc;
335 struct sr_serial_dev_inst *serial;
336 uint32_t trigger_config[4];
338 uint16_t readcount, delaycount;
339 uint8_t changrp_mask;
343 if (sdi->status != SR_ST_ACTIVE)
344 return SR_ERR_DEV_CLOSED;
349 if (ols_configure_probes(sdi) != SR_OK) {
350 sr_err("Failed to configure probes.");
355 * Enable/disable channel groups in the flag register according to the
356 * probe mask. Calculate this here, because num_channels is needed
357 * to limit readcount.
361 for (i = 0; i < 4; i++) {
362 if (devc->probe_mask & (0xff << (i * 8))) {
363 changrp_mask |= (1 << i);
369 * Limit readcount to prevent reading past the end of the hardware
372 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
374 memset(trigger_config, 0, 16);
375 trigger_config[devc->num_stages] |= 0x08;
376 if (devc->trigger_mask[0]) {
377 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
378 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
380 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
381 reverse32(devc->trigger_mask[0])) != SR_OK)
383 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
384 reverse32(devc->trigger_value[0])) != SR_OK)
386 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
387 trigger_config[0]) != SR_OK)
390 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_1,
391 reverse32(devc->trigger_mask[1])) != SR_OK)
393 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_1,
394 reverse32(devc->trigger_value[1])) != SR_OK)
396 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_1,
397 trigger_config[1]) != SR_OK)
400 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_2,
401 reverse32(devc->trigger_mask[2])) != SR_OK)
403 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_2,
404 reverse32(devc->trigger_value[2])) != SR_OK)
406 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_2,
407 trigger_config[2]) != SR_OK)
410 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_3,
411 reverse32(devc->trigger_mask[3])) != SR_OK)
413 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_3,
414 reverse32(devc->trigger_value[3])) != SR_OK)
416 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_3,
417 trigger_config[3]) != SR_OK)
420 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
421 devc->trigger_mask[0]) != SR_OK)
423 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
424 devc->trigger_value[0]) != SR_OK)
426 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
427 0x00000008) != SR_OK)
429 delaycount = readcount;
432 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
433 "demux %s)", devc->cur_samplerate, devc->cur_samplerate_divider,
434 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
435 if (send_longcommand(serial, CMD_SET_DIVIDER,
436 reverse32(devc->cur_samplerate_divider)) != SR_OK)
439 /* Send sample limit and pre/post-trigger capture ratio. */
440 data = ((readcount - 1) & 0xffff) << 16;
441 data |= (delaycount - 1) & 0xffff;
442 if (send_longcommand(serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
445 /* The flag register wants them here, and 1 means "disable channel". */
446 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
447 devc->flag_reg |= FLAG_FILTER;
449 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
450 if (send_longcommand(serial, CMD_SET_FLAGS, data) != SR_OK)
453 /* Start acquisition on the device. */
454 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
457 /* Reset all operational states. */
458 devc->num_transfers = devc->num_samples = devc->num_bytes = 0;
460 /* Send header packet to the session bus. */
461 std_session_send_df_header(cb_data, LOG_PREFIX);
463 sr_source_add(serial->fd, G_IO_IN, -1, ols_receive_data, cb_data);
468 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
472 abort_acquisition(sdi);
477 SR_PRIV struct sr_dev_driver ols_driver_info = {
479 .longname = "Openbench Logic Sniffer",
484 .dev_list = dev_list,
485 .dev_clear = dev_clear,
486 .config_get = config_get,
487 .config_set = config_set,
488 .config_list = config_list,
489 .dev_open = dev_open,
490 .dev_close = dev_close,
491 .dev_acquisition_start = dev_acquisition_start,
492 .dev_acquisition_stop = dev_acquisition_stop,