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_NONE "None"
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[] = {
64 /* Probes are numbered 0-31 (on the PCB silkscreen). */
65 SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
66 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
67 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
68 "24", "25", "26", "27", "28", "29", "30", "31",
72 /* Default supported samplerates, can be overridden by device metadata. */
73 static const uint64_t samplerates[] = {
79 SR_PRIV struct sr_dev_driver ols_driver_info;
80 static struct sr_dev_driver *di = &ols_driver_info;
82 static int init(struct sr_context *sr_ctx)
84 return std_init(sr_ctx, di, LOG_PREFIX);
87 static GSList *scan(GSList *options)
89 struct sr_config *src;
90 struct sr_dev_inst *sdi;
91 struct drv_context *drvc;
92 struct dev_context *devc;
93 struct sr_probe *probe;
94 struct sr_serial_dev_inst *serial;
98 const char *conn, *serialcomm;
105 conn = serialcomm = NULL;
106 for (l = options; l; l = l->next) {
110 conn = g_variant_get_string(src->data, NULL);
112 case SR_CONF_SERIALCOMM:
113 serialcomm = g_variant_get_string(src->data, NULL);
120 if (serialcomm == NULL)
121 serialcomm = SERIALCOMM;
123 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
126 /* The discovery procedure is like this: first send the Reset
127 * command (0x00) 5 times, since the device could be anywhere
128 * in a 5-byte command. Then send the ID command (0x02).
129 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
132 sr_info("Probing %s.", conn);
133 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
137 for (i = 0; i < 5; i++) {
138 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
139 sr_err("Port %s is not writable.", conn);
144 serial_close(serial);
145 sr_err("Could not use port %s. Quitting.", conn);
148 send_shortcommand(serial, CMD_ID);
150 /* Wait 10ms for a response. */
153 sp_get_port_handle(serial->data, &probefd.fd);
154 probefd.events = G_IO_IN;
155 g_poll(&probefd, 1, 1);
157 if (probefd.revents != G_IO_IN)
159 if (serial_read_blocking(serial, buf, 4) != 4)
161 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
164 /* Definitely using the OLS protocol, check if it supports
165 * the metadata command.
167 send_shortcommand(serial, CMD_METADATA);
168 if (g_poll(&probefd, 1, 10) > 0) {
170 sdi = get_metadata(serial);
174 /* Not an OLS -- some other board that uses the sump protocol. */
175 sr_info("Device does not support metadata.");
176 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
177 "Sump", "Logic Analyzer", "v1.0");
179 for (i = 0; i < 32; i++) {
180 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
181 ols_probe_names[i])))
183 sdi->probes = g_slist_append(sdi->probes, probe);
185 devc = ols_dev_new();
188 /* Configure samplerate and divider. */
189 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
190 sr_dbg("Failed to set default samplerate (%"PRIu64").",
192 /* Clear trigger masks, values and stages. */
193 ols_configure_probes(sdi);
194 sdi->inst_type = SR_INST_SERIAL;
197 drvc->instances = g_slist_append(drvc->instances, sdi);
198 devices = g_slist_append(devices, sdi);
200 serial_close(serial);
205 static GSList *dev_list(void)
207 return ((struct drv_context *)(di->priv))->instances;
210 static int cleanup(void)
212 return std_dev_clear(di, NULL);
215 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
216 const struct sr_channel_group *channel_group)
218 struct dev_context *devc;
227 case SR_CONF_SAMPLERATE:
228 *data = g_variant_new_uint64(devc->cur_samplerate);
230 case SR_CONF_CAPTURE_RATIO:
231 *data = g_variant_new_uint64(devc->capture_ratio);
233 case SR_CONF_LIMIT_SAMPLES:
234 *data = g_variant_new_uint64(devc->limit_samples);
236 case SR_CONF_PATTERN_MODE:
237 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
238 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
239 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
240 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
242 *data = g_variant_new_string(STR_PATTERN_NONE);
245 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
254 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
255 const struct sr_channel_group *channel_group)
257 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);
306 if (!strcmp(stropt, STR_PATTERN_NONE)) {
307 sr_info("Disabling test modes.");
309 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
310 sr_info("Enabling internal test mode.");
311 flag = FLAG_INTERNAL_TEST_MODE;
312 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
313 sr_info("Enabling external test mode.");
314 flag = FLAG_EXTERNAL_TEST_MODE;
318 if (flag != 0xffff) {
319 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
320 devc->flag_reg |= flag;
324 if (g_variant_get_boolean(data)) {
325 sr_info("Enabling channel swapping.");
326 devc->flag_reg |= FLAG_SWAP_PROBES;
328 sr_info("Disabling channel swapping.");
329 devc->flag_reg &= ~FLAG_SWAP_PROBES;
335 if (g_variant_get_boolean(data)) {
336 sr_info("Enabling RLE.");
337 devc->flag_reg |= FLAG_RLE;
339 sr_info("Disabling RLE.");
340 devc->flag_reg &= ~FLAG_RLE;
351 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
352 const struct sr_channel_group *channel_group)
354 struct dev_context *devc;
355 GVariant *gvar, *grange[2];
362 case SR_CONF_SCAN_OPTIONS:
363 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
364 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
366 case SR_CONF_DEVICE_OPTIONS:
367 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
368 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
370 case SR_CONF_SAMPLERATE:
371 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
372 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
373 ARRAY_SIZE(samplerates), sizeof(uint64_t));
374 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
375 *data = g_variant_builder_end(&gvb);
377 case SR_CONF_TRIGGER_TYPE:
378 *data = g_variant_new_string(TRIGGER_TYPE);
380 case SR_CONF_PATTERN_MODE:
381 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
383 case SR_CONF_LIMIT_SAMPLES:
387 if (devc->flag_reg & FLAG_RLE)
389 if (devc->max_samples == 0)
390 /* Device didn't specify sample memory size in metadata. */
393 * Channel groups are turned off if no probes in that group are
394 * enabled, making more room for samples for the enabled group.
396 ols_configure_probes(sdi);
398 for (i = 0; i < 4; i++) {
399 if (devc->probe_mask & (0xff << (i * 8)))
402 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
403 grange[1] = g_variant_new_uint64(devc->max_samples / num_channels);
404 *data = g_variant_new_tuple(grange, 2);
413 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
415 struct dev_context *devc;
416 struct sr_serial_dev_inst *serial;
422 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
423 arg[0] = devc->trigger_mask[stage] & 0xff;
424 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
425 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
426 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
427 if (send_longcommand(serial, cmd, arg) != SR_OK)
430 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
431 arg[0] = devc->trigger_value[stage] & 0xff;
432 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
433 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
434 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
435 if (send_longcommand(serial, cmd, arg) != SR_OK)
438 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
439 arg[0] = arg[1] = arg[3] = 0x00;
441 if (stage == devc->num_stages)
442 /* Last stage, fire when this one matches. */
443 arg[3] |= TRIGGER_START;
444 if (send_longcommand(serial, cmd, arg) != SR_OK)
450 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
453 struct dev_context *devc;
454 struct sr_serial_dev_inst *serial;
455 uint16_t samplecount, readcount, delaycount;
456 uint8_t changrp_mask, arg[4];
460 if (sdi->status != SR_ST_ACTIVE)
461 return SR_ERR_DEV_CLOSED;
466 if (ols_configure_probes(sdi) != SR_OK) {
467 sr_err("Failed to configure probes.");
472 * Enable/disable channel groups in the flag register according to the
473 * probe mask. Calculate this here, because num_channels is needed
474 * to limit readcount.
478 for (i = 0; i < 4; i++) {
479 if (devc->probe_mask & (0xff << (i * 8))) {
480 changrp_mask |= (1 << i);
486 * Limit readcount to prevent reading past the end of the hardware
489 samplecount = MIN(devc->max_samples / num_channels, devc->limit_samples);
490 readcount = samplecount / 4;
492 /* Rather read too many samples than too few. */
493 if (samplecount % 4 != 0)
496 /* Basic triggers. */
497 if (devc->trigger_mask[0] != 0x00000000) {
498 /* At least one probe has a trigger on it. */
499 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
500 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
501 for (i = 0; i <= devc->num_stages; i++) {
502 sr_dbg("Setting stage %d trigger.", i);
503 if ((ret = set_trigger(sdi, i)) != SR_OK)
507 /* No triggers configured, force trigger on first stage. */
508 sr_dbg("Forcing trigger at stage 0.");
509 if ((ret = set_trigger(sdi, 0)) != SR_OK)
511 delaycount = readcount;
515 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
516 devc->cur_samplerate, devc->cur_samplerate_divider);
517 arg[0] = devc->cur_samplerate_divider & 0xff;
518 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
519 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
521 if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
524 /* Send sample limit and pre/post-trigger capture ratio. */
525 sr_dbg("Setting sample limit %d, trigger point at %d",
526 (readcount - 1) * 4, (delaycount - 1) * 4);
527 arg[0] = ((readcount - 1) & 0xff);
528 arg[1] = ((readcount - 1) & 0xff00) >> 8;
529 arg[2] = ((delaycount - 1) & 0xff);
530 arg[3] = ((delaycount - 1) & 0xff00) >> 8;
531 if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
535 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
536 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
537 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
538 devc->flag_reg & FLAG_RLE ? "on" : "off",
539 devc->flag_reg & FLAG_FILTER ? "on": "off",
540 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
541 /* 1 means "disable channel". */
542 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
543 arg[0] = devc->flag_reg & 0xff;
544 arg[1] = devc->flag_reg >> 8;
545 arg[2] = arg[3] = 0x00;
546 if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
549 /* Start acquisition on the device. */
550 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
553 /* Reset all operational states. */
554 devc->rle_count = devc->num_transfers = 0;
555 devc->num_samples = devc->num_bytes = 0;
556 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
557 memset(devc->sample, 0, 4);
559 /* Send header packet to the session bus. */
560 std_session_send_df_header(cb_data, LOG_PREFIX);
562 serial_source_add(serial, G_IO_IN, -1, ols_receive_data, cb_data);
567 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
571 abort_acquisition(sdi);
576 SR_PRIV struct sr_dev_driver ols_driver_info = {
578 .longname = "Openbench Logic Sniffer",
583 .dev_list = dev_list,
585 .config_get = config_get,
586 .config_set = config_set,
587 .config_list = config_list,
588 .dev_open = std_serial_dev_open,
589 .dev_close = std_serial_dev_close,
590 .dev_acquisition_start = dev_acquisition_start,
591 .dev_acquisition_stop = dev_acquisition_stop,