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,
35 SR_CONF_EXTERNAL_CLOCK,
41 #define STR_PATTERN_EXTERNAL "external"
42 #define STR_PATTERN_INTERNAL "internal"
44 /* Supported methods of test pattern outputs */
47 * Capture pins 31:16 (unbuffered wing) output a test pattern
48 * that can captured on pins 0:15.
52 /** Route test pattern internally to capture buffer. */
56 /* Probes are numbered 0-31 (on the PCB silkscreen). */
57 SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
58 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
59 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
60 "24", "25", "26", "27", "28", "29", "30", "31",
64 /* Default supported samplerates, can be overridden by device metadata. */
65 static const uint64_t samplerates[] = {
71 SR_PRIV struct sr_dev_driver ols_driver_info;
72 static struct sr_dev_driver *di = &ols_driver_info;
74 static int dev_clear(void)
76 return std_dev_clear(di, NULL);
79 static int init(struct sr_context *sr_ctx)
81 return std_init(sr_ctx, di, LOG_PREFIX);
84 static GSList *scan(GSList *options)
86 struct sr_config *src;
87 struct sr_dev_inst *sdi;
88 struct drv_context *drvc;
89 struct dev_context *devc;
90 struct sr_probe *probe;
91 struct sr_serial_dev_inst *serial;
95 const char *conn, *serialcomm;
102 conn = serialcomm = NULL;
103 for (l = options; l; l = l->next) {
107 conn = g_variant_get_string(src->data, NULL);
109 case SR_CONF_SERIALCOMM:
110 serialcomm = g_variant_get_string(src->data, NULL);
117 if (serialcomm == NULL)
118 serialcomm = SERIALCOMM;
120 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
123 /* The discovery procedure is like this: first send the Reset
124 * command (0x00) 5 times, since the device could be anywhere
125 * in a 5-byte command. Then send the ID command (0x02).
126 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
129 sr_info("Probing %s.", conn);
130 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
134 for (i = 0; i < 5; i++) {
135 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
136 sr_err("Port %s is not writable.", conn);
141 serial_close(serial);
142 sr_err("Could not use port %s. Quitting.", conn);
145 send_shortcommand(serial, CMD_ID);
147 /* Wait 10ms for a response. */
150 probefd.fd = serial->fd;
151 probefd.events = G_IO_IN;
152 g_poll(&probefd, 1, 1);
154 if (probefd.revents != G_IO_IN)
156 if (serial_read(serial, buf, 4) != 4)
158 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
161 /* Definitely using the OLS protocol, check if it supports
162 * the metadata command.
164 send_shortcommand(serial, CMD_METADATA);
165 if (g_poll(&probefd, 1, 10) > 0) {
167 sdi = get_metadata(serial);
171 /* Not an OLS -- some other board that uses the sump protocol. */
172 sr_info("Device does not support metadata.");
173 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
174 "Sump", "Logic Analyzer", "v1.0");
176 for (i = 0; i < 32; i++) {
177 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
178 ols_probe_names[i])))
180 sdi->probes = g_slist_append(sdi->probes, probe);
182 devc = ols_dev_new();
185 /* Configure samplerate and divider. */
186 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
187 sr_dbg("Failed to set default samplerate (%"PRIu64").",
189 /* Clear trigger masks, values and stages. */
190 ols_configure_probes(sdi);
191 sdi->inst_type = SR_INST_SERIAL;
194 drvc->instances = g_slist_append(drvc->instances, sdi);
195 devices = g_slist_append(devices, sdi);
197 serial_close(serial);
202 static GSList *dev_list(void)
204 return ((struct drv_context *)(di->priv))->instances;
207 static int dev_open(struct sr_dev_inst *sdi)
209 struct sr_serial_dev_inst *serial;
212 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
215 sdi->status = SR_ST_ACTIVE;
220 static int dev_close(struct sr_dev_inst *sdi)
222 struct sr_serial_dev_inst *serial;
225 if (serial && serial->fd != -1) {
226 serial_close(serial);
227 sdi->status = SR_ST_INACTIVE;
233 static int cleanup(void)
238 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
240 struct dev_context *devc;
247 case SR_CONF_SAMPLERATE:
248 *data = g_variant_new_uint64(devc->cur_samplerate);
250 case SR_CONF_CAPTURE_RATIO:
251 *data = g_variant_new_uint64(devc->capture_ratio);
253 case SR_CONF_LIMIT_SAMPLES:
254 *data = g_variant_new_uint64(devc->limit_samples);
256 case SR_CONF_PATTERN_MODE:
257 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
258 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
259 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
260 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
263 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
272 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
274 struct dev_context *devc;
279 if (sdi->status != SR_ST_ACTIVE)
280 return SR_ERR_DEV_CLOSED;
285 case SR_CONF_SAMPLERATE:
286 tmp_u64 = g_variant_get_uint64(data);
287 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
288 return SR_ERR_SAMPLERATE;
289 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
291 case SR_CONF_LIMIT_SAMPLES:
292 tmp_u64 = g_variant_get_uint64(data);
293 if (tmp_u64 < MIN_NUM_SAMPLES)
295 devc->limit_samples = tmp_u64;
298 case SR_CONF_CAPTURE_RATIO:
299 devc->capture_ratio = g_variant_get_uint64(data);
300 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
301 devc->capture_ratio = 0;
306 case SR_CONF_EXTERNAL_CLOCK:
307 if (g_variant_get_boolean(data)) {
308 sr_info("Enabling external clock.");
309 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
311 sr_info("Disabled external clock.");
312 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
316 case SR_CONF_PATTERN_MODE:
317 stropt = g_variant_get_string(data, NULL);
319 if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
320 sr_info("Enabling internal test mode.");
321 devc->flag_reg |= FLAG_INTERNAL_TEST_MODE;
322 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
323 sr_info("Enabling external test mode.");
324 devc->flag_reg |= FLAG_EXTERNAL_TEST_MODE;
330 if (g_variant_get_boolean(data)) {
331 sr_info("Enabling channel swapping.");
332 devc->flag_reg |= FLAG_SWAP_PROBES;
334 sr_info("Disabling channel swapping.");
335 devc->flag_reg &= ~FLAG_SWAP_PROBES;
341 if (g_variant_get_boolean(data)) {
342 sr_info("Enabling RLE.");
343 devc->flag_reg |= FLAG_RLE;
345 sr_info("Disabling RLE.");
346 devc->flag_reg &= ~FLAG_RLE;
357 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
365 case SR_CONF_SCAN_OPTIONS:
366 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
367 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
369 case SR_CONF_DEVICE_OPTIONS:
370 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
371 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
373 case SR_CONF_SAMPLERATE:
374 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
375 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
376 ARRAY_SIZE(samplerates), sizeof(uint64_t));
377 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
378 *data = g_variant_builder_end(&gvb);
380 case SR_CONF_TRIGGER_TYPE:
381 *data = g_variant_new_string(TRIGGER_TYPE);
390 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
393 struct dev_context *devc;
394 struct sr_serial_dev_inst *serial;
395 uint32_t trigger_config[4];
397 uint16_t readcount, delaycount;
398 uint8_t changrp_mask;
402 if (sdi->status != SR_ST_ACTIVE)
403 return SR_ERR_DEV_CLOSED;
408 if (ols_configure_probes(sdi) != SR_OK) {
409 sr_err("Failed to configure probes.");
414 * Enable/disable channel groups in the flag register according to the
415 * probe mask. Calculate this here, because num_channels is needed
416 * to limit readcount.
420 for (i = 0; i < 4; i++) {
421 if (devc->probe_mask & (0xff << (i * 8))) {
422 changrp_mask |= (1 << i);
428 * Limit readcount to prevent reading past the end of the hardware
431 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
433 memset(trigger_config, 0, 16);
434 trigger_config[devc->num_stages] |= 0x08;
435 if (devc->trigger_mask[0]) {
436 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
437 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
439 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
440 reverse32(devc->trigger_mask[0])) != SR_OK)
442 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
443 reverse32(devc->trigger_value[0])) != SR_OK)
445 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
446 trigger_config[0]) != SR_OK)
449 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_1,
450 reverse32(devc->trigger_mask[1])) != SR_OK)
452 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_1,
453 reverse32(devc->trigger_value[1])) != SR_OK)
455 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_1,
456 trigger_config[1]) != SR_OK)
459 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_2,
460 reverse32(devc->trigger_mask[2])) != SR_OK)
462 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_2,
463 reverse32(devc->trigger_value[2])) != SR_OK)
465 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_2,
466 trigger_config[2]) != SR_OK)
469 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_3,
470 reverse32(devc->trigger_mask[3])) != SR_OK)
472 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_3,
473 reverse32(devc->trigger_value[3])) != SR_OK)
475 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_3,
476 trigger_config[3]) != SR_OK)
479 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
480 devc->trigger_mask[0]) != SR_OK)
482 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
483 devc->trigger_value[0]) != SR_OK)
485 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
486 0x00000008) != SR_OK)
488 delaycount = readcount;
491 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
492 "demux %s, noise_filter %s)", devc->cur_samplerate,
493 devc->cur_samplerate_divider,
494 devc->flag_reg & FLAG_DEMUX ? "on" : "off",
495 devc->flag_reg & FLAG_FILTER ? "on": "off");
496 if (send_longcommand(serial, CMD_SET_DIVIDER,
497 reverse32(devc->cur_samplerate_divider)) != SR_OK)
500 /* Send sample limit and pre/post-trigger capture ratio. */
501 data = ((readcount - 1) & 0xffff) << 16;
502 data |= (delaycount - 1) & 0xffff;
503 if (send_longcommand(serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
506 /* The flag register wants them here, and 1 means "disable channel". */
507 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
509 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
510 if (send_longcommand(serial, CMD_SET_FLAGS, data) != SR_OK)
513 /* Start acquisition on the device. */
514 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
517 /* Reset all operational states. */
518 devc->num_transfers = devc->num_samples = devc->num_bytes = 0;
519 memset(devc->sample, 0, 4);
521 /* Send header packet to the session bus. */
522 std_session_send_df_header(cb_data, LOG_PREFIX);
524 sr_source_add(serial->fd, G_IO_IN, -1, ols_receive_data, cb_data);
529 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
533 abort_acquisition(sdi);
538 SR_PRIV struct sr_dev_driver ols_driver_info = {
540 .longname = "Openbench Logic Sniffer",
545 .dev_list = dev_list,
546 .dev_clear = dev_clear,
547 .config_get = config_get,
548 .config_set = config_set,
549 .config_list = config_list,
550 .dev_open = dev_open,
551 .dev_close = dev_close,
552 .dev_acquisition_start = dev_acquisition_start,
553 .dev_acquisition_stop = dev_acquisition_stop,