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 scanopts[] = {
30 static const uint32_t devopts[] = {
31 SR_CONF_LOGIC_ANALYZER,
32 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
33 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
34 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
35 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_EXTERNAL_CLOCK | SR_CONF_SET,
37 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 SR_CONF_SWAP | SR_CONF_SET,
39 SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
42 static const int32_t trigger_matches[] = {
47 #define STR_PATTERN_NONE "None"
48 #define STR_PATTERN_EXTERNAL "External"
49 #define STR_PATTERN_INTERNAL "Internal"
51 /* Supported methods of test pattern outputs */
54 * Capture pins 31:16 (unbuffered wing) output a test pattern
55 * that can captured on pins 0:15.
59 /** Route test pattern internally to capture buffer. */
63 static const char *patterns[] = {
69 /* Channels are numbered 0-31 (on the PCB silkscreen). */
70 SR_PRIV const char *ols_channel_names[NUM_CHANNELS + 1] = {
71 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
72 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
73 "24", "25", "26", "27", "28", "29", "30", "31",
77 /* Default supported samplerates, can be overridden by device metadata. */
78 static const uint64_t samplerates[] = {
84 SR_PRIV struct sr_dev_driver ols_driver_info;
85 static struct sr_dev_driver *di = &ols_driver_info;
87 static int init(struct sr_context *sr_ctx)
89 return std_init(sr_ctx, di, LOG_PREFIX);
92 static GSList *scan(GSList *options)
94 struct sr_config *src;
95 struct sr_dev_inst *sdi;
96 struct drv_context *drvc;
97 struct dev_context *devc;
98 struct sr_channel *ch;
99 struct sr_serial_dev_inst *serial;
103 const char *conn, *serialcomm;
110 conn = serialcomm = NULL;
111 for (l = options; l; l = l->next) {
115 conn = g_variant_get_string(src->data, NULL);
117 case SR_CONF_SERIALCOMM:
118 serialcomm = g_variant_get_string(src->data, NULL);
125 if (serialcomm == NULL)
126 serialcomm = SERIALCOMM;
128 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
131 /* The discovery procedure is like this: first send the Reset
132 * command (0x00) 5 times, since the device could be anywhere
133 * in a 5-byte command. Then send the ID command (0x02).
134 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
137 sr_info("Probing %s.", conn);
138 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
142 for (i = 0; i < 5; i++) {
143 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
144 sr_err("Port %s is not writable.", conn);
149 serial_close(serial);
150 sr_err("Could not use port %s. Quitting.", conn);
153 send_shortcommand(serial, CMD_ID);
155 /* Wait 10ms for a response. */
158 sp_get_port_handle(serial->data, &probefd.fd);
159 probefd.events = G_IO_IN;
160 g_poll(&probefd, 1, 1);
162 if (probefd.revents != G_IO_IN)
164 if (serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4)) != 4)
166 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
169 /* Definitely using the OLS protocol, check if it supports
170 * the metadata command.
172 send_shortcommand(serial, CMD_METADATA);
173 if (g_poll(&probefd, 1, 10) > 0) {
175 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();
181 sdi->status = SR_ST_INACTIVE;
182 sdi->vendor = g_strdup("Sump");
183 sdi->model = g_strdup("Logic Analyzer");
184 sdi->version = g_strdup("v1.0");
186 for (i = 0; i < 32; i++) {
187 if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
188 ols_channel_names[i])))
190 sdi->channels = g_slist_append(sdi->channels, ch);
192 devc = ols_dev_new();
195 /* Configure samplerate and divider. */
196 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
197 sr_dbg("Failed to set default samplerate (%"PRIu64").",
199 sdi->inst_type = SR_INST_SERIAL;
202 drvc->instances = g_slist_append(drvc->instances, sdi);
203 devices = g_slist_append(devices, sdi);
205 serial_close(serial);
210 static GSList *dev_list(void)
212 return ((struct drv_context *)(di->priv))->instances;
215 static int cleanup(void)
217 return std_dev_clear(di, NULL);
220 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
221 const struct sr_channel_group *cg)
223 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);
247 *data = g_variant_new_string(STR_PATTERN_NONE);
250 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
259 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
260 const struct sr_channel_group *cg)
262 struct dev_context *devc;
270 if (sdi->status != SR_ST_ACTIVE)
271 return SR_ERR_DEV_CLOSED;
276 case SR_CONF_SAMPLERATE:
277 tmp_u64 = g_variant_get_uint64(data);
278 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
279 return SR_ERR_SAMPLERATE;
280 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
282 case SR_CONF_LIMIT_SAMPLES:
283 tmp_u64 = g_variant_get_uint64(data);
284 if (tmp_u64 < MIN_NUM_SAMPLES)
286 devc->limit_samples = tmp_u64;
289 case SR_CONF_CAPTURE_RATIO:
290 devc->capture_ratio = g_variant_get_uint64(data);
291 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
292 devc->capture_ratio = 0;
297 case SR_CONF_EXTERNAL_CLOCK:
298 if (g_variant_get_boolean(data)) {
299 sr_info("Enabling external clock.");
300 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
302 sr_info("Disabled external clock.");
303 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
307 case SR_CONF_PATTERN_MODE:
308 stropt = g_variant_get_string(data, NULL);
311 if (!strcmp(stropt, STR_PATTERN_NONE)) {
312 sr_info("Disabling test modes.");
314 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
315 sr_info("Enabling internal test mode.");
316 flag = FLAG_INTERNAL_TEST_MODE;
317 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
318 sr_info("Enabling external test mode.");
319 flag = FLAG_EXTERNAL_TEST_MODE;
323 if (flag != 0xffff) {
324 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
325 devc->flag_reg |= flag;
329 if (g_variant_get_boolean(data)) {
330 sr_info("Enabling channel swapping.");
331 devc->flag_reg |= FLAG_SWAP_CHANNELS;
333 sr_info("Disabling channel swapping.");
334 devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
340 if (g_variant_get_boolean(data)) {
341 sr_info("Enabling RLE.");
342 devc->flag_reg |= FLAG_RLE;
344 sr_info("Disabling RLE.");
345 devc->flag_reg &= ~FLAG_RLE;
356 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
357 const struct sr_channel_group *cg)
359 struct dev_context *devc;
360 GVariant *gvar, *grange[2];
362 int num_ols_changrp, i;
367 case SR_CONF_SCAN_OPTIONS:
368 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
369 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
371 case SR_CONF_DEVICE_OPTIONS:
372 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
373 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
375 case SR_CONF_SAMPLERATE:
376 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
377 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
378 ARRAY_SIZE(samplerates), sizeof(uint64_t));
379 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
380 *data = g_variant_builder_end(&gvb);
382 case SR_CONF_TRIGGER_MATCH:
383 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
384 trigger_matches, ARRAY_SIZE(trigger_matches),
387 case SR_CONF_PATTERN_MODE:
388 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
390 case SR_CONF_LIMIT_SAMPLES:
394 if (devc->flag_reg & FLAG_RLE)
396 if (devc->max_samples == 0)
397 /* Device didn't specify sample memory size in metadata. */
400 * Channel groups are turned off if no channels in that group are
401 * enabled, making more room for samples for the enabled group.
403 ols_channel_mask(sdi);
405 for (i = 0; i < 4; i++) {
406 if (devc->channel_mask & (0xff << (i * 8)))
409 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
411 grange[1] = g_variant_new_uint64(devc->max_samples / num_ols_changrp);
413 grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
414 *data = g_variant_new_tuple(grange, 2);
423 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
425 struct dev_context *devc;
426 struct sr_serial_dev_inst *serial;
432 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
433 arg[0] = devc->trigger_mask[stage] & 0xff;
434 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
435 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
436 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
437 if (send_longcommand(serial, cmd, arg) != SR_OK)
440 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
441 arg[0] = devc->trigger_value[stage] & 0xff;
442 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
443 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
444 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
445 if (send_longcommand(serial, cmd, arg) != SR_OK)
448 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
449 arg[0] = arg[1] = arg[3] = 0x00;
451 if (stage == devc->num_stages)
452 /* Last stage, fire when this one matches. */
453 arg[3] |= TRIGGER_START;
454 if (send_longcommand(serial, cmd, arg) != SR_OK)
460 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
463 struct dev_context *devc;
464 struct sr_serial_dev_inst *serial;
465 uint16_t samplecount, readcount, delaycount;
466 uint8_t ols_changrp_mask, arg[4];
470 if (sdi->status != SR_ST_ACTIVE)
471 return SR_ERR_DEV_CLOSED;
476 ols_channel_mask(sdi);
479 ols_changrp_mask = 0;
480 for (i = 0; i < 4; i++) {
481 if (devc->channel_mask & (0xff << (i * 8))) {
482 ols_changrp_mask |= (1 << i);
488 * Limit readcount to prevent reading past the end of the hardware
491 samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
492 readcount = samplecount / 4;
494 /* Rather read too many samples than too few. */
495 if (samplecount % 4 != 0)
498 /* Basic triggers. */
499 if (ols_convert_trigger(sdi) != SR_OK) {
500 sr_err("Failed to configure channels.");
503 if (devc->num_stages > 0) {
504 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
505 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
506 for (i = 0; i <= devc->num_stages; i++) {
507 sr_dbg("Setting OLS stage %d trigger.", i);
508 if ((ret = set_trigger(sdi, i)) != SR_OK)
512 /* No triggers configured, force trigger on first stage. */
513 sr_dbg("Forcing trigger at stage 0.");
514 if ((ret = set_trigger(sdi, 0)) != SR_OK)
516 delaycount = readcount;
520 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
521 devc->cur_samplerate, devc->cur_samplerate_divider);
522 arg[0] = devc->cur_samplerate_divider & 0xff;
523 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
524 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
526 if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
529 /* Send sample limit and pre/post-trigger capture ratio. */
530 sr_dbg("Setting sample limit %d, trigger point at %d",
531 (readcount - 1) * 4, (delaycount - 1) * 4);
532 arg[0] = ((readcount - 1) & 0xff);
533 arg[1] = ((readcount - 1) & 0xff00) >> 8;
534 arg[2] = ((delaycount - 1) & 0xff);
535 arg[3] = ((delaycount - 1) & 0xff00) >> 8;
536 if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
540 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
541 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
542 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
543 devc->flag_reg & FLAG_RLE ? "on" : "off",
544 devc->flag_reg & FLAG_FILTER ? "on": "off",
545 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
547 * Enable/disable OLS channel groups in the flag register according
548 * to the channel mask. 1 means "disable channel".
550 devc->flag_reg |= ~(ols_changrp_mask << 2) & 0x3c;
551 arg[0] = devc->flag_reg & 0xff;
552 arg[1] = devc->flag_reg >> 8;
553 arg[2] = arg[3] = 0x00;
554 if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
557 /* Start acquisition on the device. */
558 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
561 /* Reset all operational states. */
562 devc->rle_count = devc->num_transfers = 0;
563 devc->num_samples = devc->num_bytes = 0;
564 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
565 memset(devc->sample, 0, 4);
567 /* Send header packet to the session bus. */
568 std_session_send_df_header(cb_data, LOG_PREFIX);
570 serial_source_add(sdi->session, serial, G_IO_IN, -1,
571 ols_receive_data, cb_data);
576 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
580 abort_acquisition(sdi);
585 SR_PRIV struct sr_dev_driver ols_driver_info = {
587 .longname = "Openbench Logic Sniffer",
592 .dev_list = dev_list,
594 .config_get = config_get,
595 .config_set = config_set,
596 .config_list = config_list,
597 .dev_open = std_serial_dev_open,
598 .dev_close = std_serial_dev_close,
599 .dev_acquisition_start = dev_acquisition_start,
600 .dev_acquisition_stop = dev_acquisition_stop,