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 uint32_t drvopts[] = {
26 SR_CONF_LOGIC_ANALYZER,
29 static const uint32_t scanopts[] = {
34 static const uint32_t devopts[] = {
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
37 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
38 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_EXTERNAL_CLOCK | SR_CONF_SET,
40 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_SWAP | SR_CONF_SET,
42 SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
45 static const int32_t trigger_matches[] = {
50 #define STR_PATTERN_NONE "None"
51 #define STR_PATTERN_EXTERNAL "External"
52 #define STR_PATTERN_INTERNAL "Internal"
54 /* Supported methods of test pattern outputs */
57 * Capture pins 31:16 (unbuffered wing) output a test pattern
58 * that can captured on pins 0:15.
62 /** Route test pattern internally to capture buffer. */
66 static const char *patterns[] = {
72 /* Channels are numbered 0-31 (on the PCB silkscreen). */
73 SR_PRIV const char *ols_channel_names[NUM_CHANNELS + 1] = {
74 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
75 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
76 "24", "25", "26", "27", "28", "29", "30", "31",
80 /* Default supported samplerates, can be overridden by device metadata. */
81 static const uint64_t samplerates[] = {
87 SR_PRIV struct sr_dev_driver ols_driver_info;
88 static struct sr_dev_driver *di = &ols_driver_info;
90 static int init(struct sr_context *sr_ctx)
92 return std_init(sr_ctx, di, LOG_PREFIX);
95 static GSList *scan(GSList *options)
97 struct sr_config *src;
98 struct sr_dev_inst *sdi;
99 struct drv_context *drvc;
100 struct dev_context *devc;
101 struct sr_channel *ch;
102 struct sr_serial_dev_inst *serial;
106 const char *conn, *serialcomm;
113 conn = serialcomm = NULL;
114 for (l = options; l; l = l->next) {
118 conn = g_variant_get_string(src->data, NULL);
120 case SR_CONF_SERIALCOMM:
121 serialcomm = g_variant_get_string(src->data, NULL);
128 if (serialcomm == NULL)
129 serialcomm = SERIALCOMM;
131 serial = sr_serial_dev_inst_new(conn, serialcomm);
133 /* The discovery procedure is like this: first send the Reset
134 * command (0x00) 5 times, since the device could be anywhere
135 * in a 5-byte command. Then send the ID command (0x02).
136 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
139 sr_info("Probing %s.", conn);
140 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
144 for (i = 0; i < 5; i++) {
145 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
146 sr_err("Port %s is not writable.", conn);
151 serial_close(serial);
152 sr_err("Could not use port %s. Quitting.", conn);
155 send_shortcommand(serial, CMD_ID);
157 /* Wait 10ms for a response. */
160 if (sp_input_waiting(serial->data) == 0) {
161 sr_dbg("Didn't get any reply.");
165 ret = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
167 sr_err("Invalid reply (expected 4 bytes, got %d).", ret);
171 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
172 sr_err("Invalid reply (expected '1SLO' or '1ALS', got "
173 "'%c%c%c%c').", buf[0], buf[1], buf[2], buf[3]);
177 /* Definitely using the OLS protocol, check if it supports
178 * the metadata command.
180 send_shortcommand(serial, CMD_METADATA);
182 /* Wait 10ms for a response. */
185 if (sp_input_waiting(serial->data) != 0) {
187 sdi = get_metadata(serial);
190 /* Not an OLS -- some other board that uses the sump protocol. */
191 sr_info("Device does not support metadata.");
192 sdi = g_malloc0(sizeof(struct sr_dev_inst));
193 sdi->status = SR_ST_INACTIVE;
194 sdi->vendor = g_strdup("Sump");
195 sdi->model = g_strdup("Logic Analyzer");
196 sdi->version = g_strdup("v1.0");
198 for (i = 0; i < 32; i++) {
199 ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
200 ols_channel_names[i]);
201 sdi->channels = g_slist_append(sdi->channels, ch);
203 devc = ols_dev_new();
206 /* Configure samplerate and divider. */
207 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
208 sr_dbg("Failed to set default samplerate (%"PRIu64").",
210 sdi->inst_type = SR_INST_SERIAL;
213 drvc->instances = g_slist_append(drvc->instances, sdi);
214 devices = g_slist_append(devices, sdi);
216 serial_close(serial);
221 static GSList *dev_list(void)
223 return ((struct drv_context *)(di->priv))->instances;
226 static int cleanup(void)
228 return std_dev_clear(di, NULL);
231 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
232 const struct sr_channel_group *cg)
234 struct dev_context *devc;
243 case SR_CONF_SAMPLERATE:
244 *data = g_variant_new_uint64(devc->cur_samplerate);
246 case SR_CONF_CAPTURE_RATIO:
247 *data = g_variant_new_uint64(devc->capture_ratio);
249 case SR_CONF_LIMIT_SAMPLES:
250 *data = g_variant_new_uint64(devc->limit_samples);
252 case SR_CONF_PATTERN_MODE:
253 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
254 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
255 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
256 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
258 *data = g_variant_new_string(STR_PATTERN_NONE);
261 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
270 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
271 const struct sr_channel_group *cg)
273 struct dev_context *devc;
281 if (sdi->status != SR_ST_ACTIVE)
282 return SR_ERR_DEV_CLOSED;
287 case SR_CONF_SAMPLERATE:
288 tmp_u64 = g_variant_get_uint64(data);
289 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
290 return SR_ERR_SAMPLERATE;
291 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
293 case SR_CONF_LIMIT_SAMPLES:
294 tmp_u64 = g_variant_get_uint64(data);
295 if (tmp_u64 < MIN_NUM_SAMPLES)
297 devc->limit_samples = tmp_u64;
300 case SR_CONF_CAPTURE_RATIO:
301 devc->capture_ratio = g_variant_get_uint64(data);
302 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
303 devc->capture_ratio = 0;
308 case SR_CONF_EXTERNAL_CLOCK:
309 if (g_variant_get_boolean(data)) {
310 sr_info("Enabling external clock.");
311 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
313 sr_info("Disabled external clock.");
314 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
318 case SR_CONF_PATTERN_MODE:
319 stropt = g_variant_get_string(data, NULL);
322 if (!strcmp(stropt, STR_PATTERN_NONE)) {
323 sr_info("Disabling test modes.");
325 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
326 sr_info("Enabling internal test mode.");
327 flag = FLAG_INTERNAL_TEST_MODE;
328 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
329 sr_info("Enabling external test mode.");
330 flag = FLAG_EXTERNAL_TEST_MODE;
334 if (flag != 0xffff) {
335 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
336 devc->flag_reg |= flag;
340 if (g_variant_get_boolean(data)) {
341 sr_info("Enabling channel swapping.");
342 devc->flag_reg |= FLAG_SWAP_CHANNELS;
344 sr_info("Disabling channel swapping.");
345 devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
351 if (g_variant_get_boolean(data)) {
352 sr_info("Enabling RLE.");
353 devc->flag_reg |= FLAG_RLE;
355 sr_info("Disabling RLE.");
356 devc->flag_reg &= ~FLAG_RLE;
367 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
368 const struct sr_channel_group *cg)
370 struct dev_context *devc;
371 GVariant *gvar, *grange[2];
373 int num_ols_changrp, i;
378 case SR_CONF_SCAN_OPTIONS:
379 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
380 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
382 case SR_CONF_DEVICE_OPTIONS:
384 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
385 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
387 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
388 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
390 case SR_CONF_SAMPLERATE:
391 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
392 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
393 ARRAY_SIZE(samplerates), sizeof(uint64_t));
394 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
395 *data = g_variant_builder_end(&gvb);
397 case SR_CONF_TRIGGER_MATCH:
398 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
399 trigger_matches, ARRAY_SIZE(trigger_matches),
402 case SR_CONF_PATTERN_MODE:
403 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
405 case SR_CONF_LIMIT_SAMPLES:
409 if (devc->flag_reg & FLAG_RLE)
411 if (devc->max_samples == 0)
412 /* Device didn't specify sample memory size in metadata. */
415 * Channel groups are turned off if no channels in that group are
416 * enabled, making more room for samples for the enabled group.
418 ols_channel_mask(sdi);
420 for (i = 0; i < 4; i++) {
421 if (devc->channel_mask & (0xff << (i * 8)))
424 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
426 grange[1] = g_variant_new_uint64(devc->max_samples / num_ols_changrp);
428 grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
429 *data = g_variant_new_tuple(grange, 2);
438 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
440 struct dev_context *devc;
441 struct sr_serial_dev_inst *serial;
447 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
448 arg[0] = devc->trigger_mask[stage] & 0xff;
449 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
450 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
451 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
452 if (send_longcommand(serial, cmd, arg) != SR_OK)
455 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
456 arg[0] = devc->trigger_value[stage] & 0xff;
457 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
458 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
459 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
460 if (send_longcommand(serial, cmd, arg) != SR_OK)
463 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
464 arg[0] = arg[1] = arg[3] = 0x00;
466 if (stage == devc->num_stages)
467 /* Last stage, fire when this one matches. */
468 arg[3] |= TRIGGER_START;
469 if (send_longcommand(serial, cmd, arg) != SR_OK)
475 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
478 struct dev_context *devc;
479 struct sr_serial_dev_inst *serial;
480 uint16_t samplecount, readcount, delaycount;
481 uint8_t ols_changrp_mask, arg[4];
485 if (sdi->status != SR_ST_ACTIVE)
486 return SR_ERR_DEV_CLOSED;
491 ols_channel_mask(sdi);
494 ols_changrp_mask = 0;
495 for (i = 0; i < 4; i++) {
496 if (devc->channel_mask & (0xff << (i * 8))) {
497 ols_changrp_mask |= (1 << i);
503 * Limit readcount to prevent reading past the end of the hardware
506 samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
507 readcount = samplecount / 4;
509 /* Rather read too many samples than too few. */
510 if (samplecount % 4 != 0)
513 /* Basic triggers. */
514 if (ols_convert_trigger(sdi) != SR_OK) {
515 sr_err("Failed to configure channels.");
518 if (devc->num_stages > 0) {
519 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
520 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
521 for (i = 0; i <= devc->num_stages; i++) {
522 sr_dbg("Setting OLS stage %d trigger.", i);
523 if ((ret = set_trigger(sdi, i)) != SR_OK)
527 /* No triggers configured, force trigger on first stage. */
528 sr_dbg("Forcing trigger at stage 0.");
529 if ((ret = set_trigger(sdi, 0)) != SR_OK)
531 delaycount = readcount;
535 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
536 devc->cur_samplerate, devc->cur_samplerate_divider);
537 arg[0] = devc->cur_samplerate_divider & 0xff;
538 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
539 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
541 if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
544 /* Send sample limit and pre/post-trigger capture ratio. */
545 sr_dbg("Setting sample limit %d, trigger point at %d",
546 (readcount - 1) * 4, (delaycount - 1) * 4);
547 arg[0] = ((readcount - 1) & 0xff);
548 arg[1] = ((readcount - 1) & 0xff00) >> 8;
549 arg[2] = ((delaycount - 1) & 0xff);
550 arg[3] = ((delaycount - 1) & 0xff00) >> 8;
551 if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
555 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
556 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
557 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
558 devc->flag_reg & FLAG_RLE ? "on" : "off",
559 devc->flag_reg & FLAG_FILTER ? "on": "off",
560 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
562 * Enable/disable OLS channel groups in the flag register according
563 * to the channel mask. 1 means "disable channel".
565 devc->flag_reg |= ~(ols_changrp_mask << 2) & 0x3c;
566 arg[0] = devc->flag_reg & 0xff;
567 arg[1] = devc->flag_reg >> 8;
568 arg[2] = arg[3] = 0x00;
569 if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
572 /* Start acquisition on the device. */
573 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
576 /* Reset all operational states. */
577 devc->rle_count = devc->num_transfers = 0;
578 devc->num_samples = devc->num_bytes = 0;
579 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
580 memset(devc->sample, 0, 4);
582 /* Send header packet to the session bus. */
583 std_session_send_df_header(cb_data, LOG_PREFIX);
585 serial_source_add(sdi->session, serial, G_IO_IN, -1,
586 ols_receive_data, cb_data);
591 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
595 abort_acquisition(sdi);
600 SR_PRIV struct sr_dev_driver ols_driver_info = {
602 .longname = "Openbench Logic Sniffer",
607 .dev_list = dev_list,
609 .config_get = config_get,
610 .config_set = config_set,
611 .config_list = config_list,
612 .dev_open = std_serial_dev_open,
613 .dev_close = std_serial_dev_close,
614 .dev_acquisition_start = dev_acquisition_start,
615 .dev_acquisition_stop = dev_acquisition_stop,