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/>.
21 #include <libserialport.h>
23 #define SERIALCOMM "115200/8n1"
25 static const int32_t hwopts[] = {
30 static const int32_t hwcaps[] = {
31 SR_CONF_LOGIC_ANALYZER,
34 SR_CONF_CAPTURE_RATIO,
35 SR_CONF_LIMIT_SAMPLES,
36 SR_CONF_EXTERNAL_CLOCK,
42 #define STR_PATTERN_EXTERNAL "external"
43 #define STR_PATTERN_INTERNAL "internal"
45 /* Supported methods of test pattern outputs */
48 * Capture pins 31:16 (unbuffered wing) output a test pattern
49 * that can captured on pins 0:15.
53 /** Route test pattern internally to capture buffer. */
57 static const char *patterns[] = {
62 /* Probes are numbered 0-31 (on the PCB silkscreen). */
63 SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
64 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
65 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
66 "24", "25", "26", "27", "28", "29", "30", "31",
70 /* Default supported samplerates, can be overridden by device metadata. */
71 static const uint64_t samplerates[] = {
77 SR_PRIV struct sr_dev_driver ols_driver_info;
78 static struct sr_dev_driver *di = &ols_driver_info;
80 static int dev_clear(void)
82 return std_dev_clear(di, NULL);
85 static int init(struct sr_context *sr_ctx)
87 return std_init(sr_ctx, di, LOG_PREFIX);
90 static GSList *scan(GSList *options)
92 struct sr_config *src;
93 struct sr_dev_inst *sdi;
94 struct drv_context *drvc;
95 struct dev_context *devc;
96 struct sr_probe *probe;
97 struct sr_serial_dev_inst *serial;
101 const char *conn, *serialcomm;
108 conn = serialcomm = NULL;
109 for (l = options; l; l = l->next) {
113 conn = g_variant_get_string(src->data, NULL);
115 case SR_CONF_SERIALCOMM:
116 serialcomm = g_variant_get_string(src->data, NULL);
123 if (serialcomm == NULL)
124 serialcomm = SERIALCOMM;
126 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
129 /* The discovery procedure is like this: first send the Reset
130 * command (0x00) 5 times, since the device could be anywhere
131 * in a 5-byte command. Then send the ID command (0x02).
132 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
135 sr_info("Probing %s.", conn);
136 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
140 for (i = 0; i < 5; i++) {
141 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
142 sr_err("Port %s is not writable.", conn);
147 serial_close(serial);
148 sr_err("Could not use port %s. Quitting.", conn);
151 send_shortcommand(serial, CMD_ID);
153 /* Wait 10ms for a response. */
156 sp_get_port_handle(serial->data, &probefd.fd);
157 probefd.events = G_IO_IN;
158 g_poll(&probefd, 1, 1);
160 if (probefd.revents != G_IO_IN)
162 if (serial_read_blocking(serial, buf, 4) != 4)
164 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
167 /* Definitely using the OLS protocol, check if it supports
168 * the metadata command.
170 send_shortcommand(serial, CMD_METADATA);
171 if (g_poll(&probefd, 1, 10) > 0) {
173 sdi = get_metadata(serial);
177 /* Not an OLS -- some other board that uses the sump protocol. */
178 sr_info("Device does not support metadata.");
179 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
180 "Sump", "Logic Analyzer", "v1.0");
182 for (i = 0; i < 32; i++) {
183 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
184 ols_probe_names[i])))
186 sdi->probes = g_slist_append(sdi->probes, probe);
188 devc = ols_dev_new();
191 /* Configure samplerate and divider. */
192 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
193 sr_dbg("Failed to set default samplerate (%"PRIu64").",
195 /* Clear trigger masks, values and stages. */
196 ols_configure_probes(sdi);
197 sdi->inst_type = SR_INST_SERIAL;
200 drvc->instances = g_slist_append(drvc->instances, sdi);
201 devices = g_slist_append(devices, sdi);
203 serial_close(serial);
208 static GSList *dev_list(void)
210 return ((struct drv_context *)(di->priv))->instances;
213 static int cleanup(void)
218 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
219 const struct sr_probe_group *probe_group)
221 struct dev_context *devc;
230 case SR_CONF_SAMPLERATE:
231 *data = g_variant_new_uint64(devc->cur_samplerate);
233 case SR_CONF_CAPTURE_RATIO:
234 *data = g_variant_new_uint64(devc->capture_ratio);
236 case SR_CONF_LIMIT_SAMPLES:
237 *data = g_variant_new_uint64(devc->limit_samples);
239 case SR_CONF_PATTERN_MODE:
240 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
241 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
242 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
243 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
246 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
255 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
256 const struct sr_probe_group *probe_group)
258 struct dev_context *devc;
265 if (sdi->status != SR_ST_ACTIVE)
266 return SR_ERR_DEV_CLOSED;
271 case SR_CONF_SAMPLERATE:
272 tmp_u64 = g_variant_get_uint64(data);
273 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
274 return SR_ERR_SAMPLERATE;
275 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
277 case SR_CONF_LIMIT_SAMPLES:
278 tmp_u64 = g_variant_get_uint64(data);
279 if (tmp_u64 < MIN_NUM_SAMPLES)
281 devc->limit_samples = tmp_u64;
284 case SR_CONF_CAPTURE_RATIO:
285 devc->capture_ratio = g_variant_get_uint64(data);
286 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
287 devc->capture_ratio = 0;
292 case SR_CONF_EXTERNAL_CLOCK:
293 if (g_variant_get_boolean(data)) {
294 sr_info("Enabling external clock.");
295 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
297 sr_info("Disabled external clock.");
298 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
302 case SR_CONF_PATTERN_MODE:
303 stropt = g_variant_get_string(data, NULL);
305 if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
306 sr_info("Enabling internal test mode.");
307 devc->flag_reg |= FLAG_INTERNAL_TEST_MODE;
308 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
309 sr_info("Enabling external test mode.");
310 devc->flag_reg |= FLAG_EXTERNAL_TEST_MODE;
316 if (g_variant_get_boolean(data)) {
317 sr_info("Enabling channel swapping.");
318 devc->flag_reg |= FLAG_SWAP_PROBES;
320 sr_info("Disabling channel swapping.");
321 devc->flag_reg &= ~FLAG_SWAP_PROBES;
327 if (g_variant_get_boolean(data)) {
328 sr_info("Enabling RLE.");
329 devc->flag_reg |= FLAG_RLE;
331 sr_info("Disabling RLE.");
332 devc->flag_reg &= ~FLAG_RLE;
343 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
344 const struct sr_probe_group *probe_group)
346 struct dev_context *devc;
347 GVariant *gvar, *grange[2];
354 case SR_CONF_SCAN_OPTIONS:
355 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
356 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
358 case SR_CONF_DEVICE_OPTIONS:
359 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
360 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
362 case SR_CONF_SAMPLERATE:
363 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
364 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
365 ARRAY_SIZE(samplerates), sizeof(uint64_t));
366 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
367 *data = g_variant_builder_end(&gvb);
369 case SR_CONF_TRIGGER_TYPE:
370 *data = g_variant_new_string(TRIGGER_TYPE);
372 case SR_CONF_PATTERN_MODE:
373 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
375 case SR_CONF_LIMIT_SAMPLES:
379 if (devc->flag_reg & FLAG_RLE)
381 if (devc->max_samples == 0)
382 /* Device didn't specify sample memory size in metadata. */
385 * Channel groups are turned off if no probes in that group are
386 * enabled, making more room for samples for the enabled group.
388 ols_configure_probes(sdi);
390 for (i = 0; i < 4; i++) {
391 if (devc->probe_mask & (0xff << (i * 8)))
394 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
395 grange[1] = g_variant_new_uint64(devc->max_samples / num_channels);
396 *data = g_variant_new_tuple(grange, 2);
405 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
408 struct dev_context *devc;
409 struct sr_serial_dev_inst *serial;
410 uint32_t trigger_config[4];
412 uint16_t readcount, delaycount;
413 uint8_t changrp_mask;
417 if (sdi->status != SR_ST_ACTIVE)
418 return SR_ERR_DEV_CLOSED;
423 if (ols_configure_probes(sdi) != SR_OK) {
424 sr_err("Failed to configure probes.");
429 * Enable/disable channel groups in the flag register according to the
430 * probe mask. Calculate this here, because num_channels is needed
431 * to limit readcount.
435 for (i = 0; i < 4; i++) {
436 if (devc->probe_mask & (0xff << (i * 8))) {
437 changrp_mask |= (1 << i);
443 * Limit readcount to prevent reading past the end of the hardware
446 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
448 memset(trigger_config, 0, 16);
449 trigger_config[devc->num_stages] |= 0x08;
450 if (devc->trigger_mask[0]) {
451 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
452 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
454 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
455 reverse32(devc->trigger_mask[0])) != SR_OK)
457 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
458 reverse32(devc->trigger_value[0])) != SR_OK)
460 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
461 trigger_config[0]) != SR_OK)
464 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_1,
465 reverse32(devc->trigger_mask[1])) != SR_OK)
467 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_1,
468 reverse32(devc->trigger_value[1])) != SR_OK)
470 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_1,
471 trigger_config[1]) != SR_OK)
474 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_2,
475 reverse32(devc->trigger_mask[2])) != SR_OK)
477 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_2,
478 reverse32(devc->trigger_value[2])) != SR_OK)
480 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_2,
481 trigger_config[2]) != SR_OK)
484 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_3,
485 reverse32(devc->trigger_mask[3])) != SR_OK)
487 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_3,
488 reverse32(devc->trigger_value[3])) != SR_OK)
490 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_3,
491 trigger_config[3]) != SR_OK)
494 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
495 devc->trigger_mask[0]) != SR_OK)
497 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
498 devc->trigger_value[0]) != SR_OK)
500 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
501 0x00000008) != SR_OK)
503 delaycount = readcount;
506 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
507 "demux %s, noise_filter %s)", devc->cur_samplerate,
508 devc->cur_samplerate_divider,
509 devc->flag_reg & FLAG_DEMUX ? "on" : "off",
510 devc->flag_reg & FLAG_FILTER ? "on": "off");
511 if (send_longcommand(serial, CMD_SET_DIVIDER,
512 reverse32(devc->cur_samplerate_divider)) != SR_OK)
515 /* Send sample limit and pre/post-trigger capture ratio. */
516 data = ((readcount - 1) & 0xffff) << 16;
517 data |= (delaycount - 1) & 0xffff;
518 if (send_longcommand(serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
521 /* The flag register wants them here, and 1 means "disable channel". */
522 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
524 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
525 if (send_longcommand(serial, CMD_SET_FLAGS, data) != SR_OK)
528 /* Start acquisition on the device. */
529 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
532 /* Reset all operational states. */
533 devc->num_transfers = devc->num_samples = devc->num_bytes = 0;
534 memset(devc->sample, 0, 4);
536 /* Send header packet to the session bus. */
537 std_session_send_df_header(cb_data, LOG_PREFIX);
539 serial_source_add(serial, G_IO_IN, -1, ols_receive_data, cb_data);
544 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
548 abort_acquisition(sdi);
553 SR_PRIV struct sr_dev_driver ols_driver_info = {
555 .longname = "Openbench Logic Sniffer",
560 .dev_list = dev_list,
561 .dev_clear = dev_clear,
562 .config_get = config_get,
563 .config_set = config_set,
564 .config_list = config_list,
565 .dev_open = std_serial_dev_open,
566 .dev_close = std_serial_dev_close,
567 .dev_acquisition_start = dev_acquisition_start,
568 .dev_acquisition_stop = dev_acquisition_stop,