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,
40 SR_CONF_MAX_UNCOMPRESSED_SAMPLES,
43 #define STR_PATTERN_EXTERNAL "external"
44 #define STR_PATTERN_INTERNAL "internal"
46 /* Supported methods of test pattern outputs */
49 * Capture pins 31:16 (unbuffered wing) output a test pattern
50 * that can captured on pins 0:15.
54 /** Route test pattern internally to capture buffer. */
58 static const char *patterns[] = {
63 /* Probes are numbered 0-31 (on the PCB silkscreen). */
64 SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
65 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
66 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
67 "24", "25", "26", "27", "28", "29", "30", "31",
71 /* Default supported samplerates, can be overridden by device metadata. */
72 static const uint64_t samplerates[] = {
78 SR_PRIV struct sr_dev_driver ols_driver_info;
79 static struct sr_dev_driver *di = &ols_driver_info;
81 static int dev_clear(void)
83 return std_dev_clear(di, NULL);
86 static int init(struct sr_context *sr_ctx)
88 return std_init(sr_ctx, di, LOG_PREFIX);
91 static GSList *scan(GSList *options)
93 struct sr_config *src;
94 struct sr_dev_inst *sdi;
95 struct drv_context *drvc;
96 struct dev_context *devc;
97 struct sr_probe *probe;
98 struct sr_serial_dev_inst *serial;
102 const char *conn, *serialcomm;
109 conn = serialcomm = NULL;
110 for (l = options; l; l = l->next) {
114 conn = g_variant_get_string(src->data, NULL);
116 case SR_CONF_SERIALCOMM:
117 serialcomm = g_variant_get_string(src->data, NULL);
124 if (serialcomm == NULL)
125 serialcomm = SERIALCOMM;
127 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
130 /* The discovery procedure is like this: first send the Reset
131 * command (0x00) 5 times, since the device could be anywhere
132 * in a 5-byte command. Then send the ID command (0x02).
133 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
136 sr_info("Probing %s.", conn);
137 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
141 for (i = 0; i < 5; i++) {
142 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
143 sr_err("Port %s is not writable.", conn);
148 serial_close(serial);
149 sr_err("Could not use port %s. Quitting.", conn);
152 send_shortcommand(serial, CMD_ID);
154 /* Wait 10ms for a response. */
157 sp_get_port_handle(serial->data, &probefd.fd);
158 probefd.events = G_IO_IN;
159 g_poll(&probefd, 1, 1);
161 if (probefd.revents != G_IO_IN)
163 if (serial_read_blocking(serial, buf, 4) != 4)
165 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
168 /* Definitely using the OLS protocol, check if it supports
169 * the metadata command.
171 send_shortcommand(serial, CMD_METADATA);
172 if (g_poll(&probefd, 1, 10) > 0) {
174 sdi = get_metadata(serial);
178 /* Not an OLS -- some other board that uses the sump protocol. */
179 sr_info("Device does not support metadata.");
180 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
181 "Sump", "Logic Analyzer", "v1.0");
183 for (i = 0; i < 32; i++) {
184 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
185 ols_probe_names[i])))
187 sdi->probes = g_slist_append(sdi->probes, probe);
189 devc = ols_dev_new();
192 /* Configure samplerate and divider. */
193 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
194 sr_dbg("Failed to set default samplerate (%"PRIu64").",
196 /* Clear trigger masks, values and stages. */
197 ols_configure_probes(sdi);
198 sdi->inst_type = SR_INST_SERIAL;
201 drvc->instances = g_slist_append(drvc->instances, sdi);
202 devices = g_slist_append(devices, sdi);
204 serial_close(serial);
209 static GSList *dev_list(void)
211 return ((struct drv_context *)(di->priv))->instances;
214 static int cleanup(void)
219 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
220 const struct sr_probe_group *probe_group)
222 struct dev_context *devc;
232 case SR_CONF_SAMPLERATE:
233 *data = g_variant_new_uint64(devc->cur_samplerate);
235 case SR_CONF_CAPTURE_RATIO:
236 *data = g_variant_new_uint64(devc->capture_ratio);
238 case SR_CONF_LIMIT_SAMPLES:
239 *data = g_variant_new_uint64(devc->limit_samples);
241 case SR_CONF_PATTERN_MODE:
242 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
243 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
244 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
245 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
248 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
250 case SR_CONF_MAX_UNCOMPRESSED_SAMPLES:
251 if (devc->flag_reg & FLAG_RLE)
253 if (devc->max_samples == 0)
254 /* Device didn't specify sample memory size in metadata. */
257 * Channel groups are turned off if no probes in that group are
258 * enabled, making more room for samples for the enabled group.
260 ols_configure_probes(sdi);
262 for (i = 0; i < 4; i++) {
263 if (devc->probe_mask & (0xff << (i * 8)))
266 *data = g_variant_new_uint64(devc->max_samples / num_channels);
275 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
276 const struct sr_probe_group *probe_group)
278 struct dev_context *devc;
285 if (sdi->status != SR_ST_ACTIVE)
286 return SR_ERR_DEV_CLOSED;
291 case SR_CONF_SAMPLERATE:
292 tmp_u64 = g_variant_get_uint64(data);
293 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
294 return SR_ERR_SAMPLERATE;
295 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
297 case SR_CONF_LIMIT_SAMPLES:
298 tmp_u64 = g_variant_get_uint64(data);
299 if (tmp_u64 < MIN_NUM_SAMPLES)
301 devc->limit_samples = tmp_u64;
304 case SR_CONF_CAPTURE_RATIO:
305 devc->capture_ratio = g_variant_get_uint64(data);
306 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
307 devc->capture_ratio = 0;
312 case SR_CONF_EXTERNAL_CLOCK:
313 if (g_variant_get_boolean(data)) {
314 sr_info("Enabling external clock.");
315 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
317 sr_info("Disabled external clock.");
318 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
322 case SR_CONF_PATTERN_MODE:
323 stropt = g_variant_get_string(data, NULL);
325 if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
326 sr_info("Enabling internal test mode.");
327 devc->flag_reg |= FLAG_INTERNAL_TEST_MODE;
328 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
329 sr_info("Enabling external test mode.");
330 devc->flag_reg |= FLAG_EXTERNAL_TEST_MODE;
336 if (g_variant_get_boolean(data)) {
337 sr_info("Enabling channel swapping.");
338 devc->flag_reg |= FLAG_SWAP_PROBES;
340 sr_info("Disabling channel swapping.");
341 devc->flag_reg &= ~FLAG_SWAP_PROBES;
347 if (g_variant_get_boolean(data)) {
348 sr_info("Enabling RLE.");
349 devc->flag_reg |= FLAG_RLE;
351 sr_info("Disabling RLE.");
352 devc->flag_reg &= ~FLAG_RLE;
363 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
364 const struct sr_probe_group *probe_group)
373 case SR_CONF_SCAN_OPTIONS:
374 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
375 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
377 case SR_CONF_DEVICE_OPTIONS:
378 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
379 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
381 case SR_CONF_SAMPLERATE:
382 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
383 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
384 ARRAY_SIZE(samplerates), sizeof(uint64_t));
385 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
386 *data = g_variant_builder_end(&gvb);
388 case SR_CONF_TRIGGER_TYPE:
389 *data = g_variant_new_string(TRIGGER_TYPE);
391 case SR_CONF_PATTERN_MODE:
392 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
401 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
404 struct dev_context *devc;
405 struct sr_serial_dev_inst *serial;
406 uint32_t trigger_config[4];
408 uint16_t readcount, delaycount;
409 uint8_t changrp_mask;
413 if (sdi->status != SR_ST_ACTIVE)
414 return SR_ERR_DEV_CLOSED;
419 if (ols_configure_probes(sdi) != SR_OK) {
420 sr_err("Failed to configure probes.");
425 * Enable/disable channel groups in the flag register according to the
426 * probe mask. Calculate this here, because num_channels is needed
427 * to limit readcount.
431 for (i = 0; i < 4; i++) {
432 if (devc->probe_mask & (0xff << (i * 8))) {
433 changrp_mask |= (1 << i);
439 * Limit readcount to prevent reading past the end of the hardware
442 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
444 memset(trigger_config, 0, 16);
445 trigger_config[devc->num_stages] |= 0x08;
446 if (devc->trigger_mask[0]) {
447 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
448 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
450 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
451 reverse32(devc->trigger_mask[0])) != SR_OK)
453 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
454 reverse32(devc->trigger_value[0])) != SR_OK)
456 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
457 trigger_config[0]) != SR_OK)
460 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_1,
461 reverse32(devc->trigger_mask[1])) != SR_OK)
463 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_1,
464 reverse32(devc->trigger_value[1])) != SR_OK)
466 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_1,
467 trigger_config[1]) != SR_OK)
470 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_2,
471 reverse32(devc->trigger_mask[2])) != SR_OK)
473 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_2,
474 reverse32(devc->trigger_value[2])) != SR_OK)
476 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_2,
477 trigger_config[2]) != SR_OK)
480 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_3,
481 reverse32(devc->trigger_mask[3])) != SR_OK)
483 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_3,
484 reverse32(devc->trigger_value[3])) != SR_OK)
486 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_3,
487 trigger_config[3]) != SR_OK)
490 if (send_longcommand(serial, CMD_SET_TRIGGER_MASK_0,
491 devc->trigger_mask[0]) != SR_OK)
493 if (send_longcommand(serial, CMD_SET_TRIGGER_VALUE_0,
494 devc->trigger_value[0]) != SR_OK)
496 if (send_longcommand(serial, CMD_SET_TRIGGER_CONFIG_0,
497 0x00000008) != SR_OK)
499 delaycount = readcount;
502 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
503 "demux %s, noise_filter %s)", devc->cur_samplerate,
504 devc->cur_samplerate_divider,
505 devc->flag_reg & FLAG_DEMUX ? "on" : "off",
506 devc->flag_reg & FLAG_FILTER ? "on": "off");
507 if (send_longcommand(serial, CMD_SET_DIVIDER,
508 reverse32(devc->cur_samplerate_divider)) != SR_OK)
511 /* Send sample limit and pre/post-trigger capture ratio. */
512 data = ((readcount - 1) & 0xffff) << 16;
513 data |= (delaycount - 1) & 0xffff;
514 if (send_longcommand(serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
517 /* The flag register wants them here, and 1 means "disable channel". */
518 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
520 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
521 if (send_longcommand(serial, CMD_SET_FLAGS, data) != SR_OK)
524 /* Start acquisition on the device. */
525 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
528 /* Reset all operational states. */
529 devc->num_transfers = devc->num_samples = devc->num_bytes = 0;
530 memset(devc->sample, 0, 4);
532 /* Send header packet to the session bus. */
533 std_session_send_df_header(cb_data, LOG_PREFIX);
535 serial_source_add(serial, G_IO_IN, -1, ols_receive_data, cb_data);
540 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
544 abort_acquisition(sdi);
549 SR_PRIV struct sr_dev_driver ols_driver_info = {
551 .longname = "Openbench Logic Sniffer",
556 .dev_list = dev_list,
557 .dev_clear = dev_clear,
558 .config_get = config_get,
559 .config_set = config_set,
560 .config_list = config_list,
561 .dev_open = std_serial_dev_open,
562 .dev_close = std_serial_dev_close,
563 .dev_acquisition_start = dev_acquisition_start,
564 .dev_acquisition_stop = dev_acquisition_stop,