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/>.
20 #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[] = {
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",
79 /* Default supported samplerates, can be overridden by device metadata. */
80 static const uint64_t samplerates[] = {
86 #define RESPONSE_DELAY_US (10 * 1000)
88 SR_PRIV struct sr_dev_driver ols_driver_info;
90 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
92 return std_init(sr_ctx, di, LOG_PREFIX);
95 static GSList *scan(struct sr_dev_driver *di, 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_serial_dev_inst *serial;
105 const char *conn, *serialcomm;
112 conn = serialcomm = NULL;
113 for (l = options; l; l = l->next) {
117 conn = g_variant_get_string(src->data, NULL);
119 case SR_CONF_SERIALCOMM:
120 serialcomm = g_variant_get_string(src->data, NULL);
128 serialcomm = SERIALCOMM;
130 serial = sr_serial_dev_inst_new(conn, serialcomm);
132 /* The discovery procedure is like this: first send the Reset
133 * command (0x00) 5 times, since the device could be anywhere
134 * in a 5-byte command. Then send the ID command (0x02).
135 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
138 sr_info("Probing %s.", conn);
139 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
143 for (i = 0; i < 5; i++) {
144 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
145 sr_err("Port %s is not writable.", conn);
150 serial_close(serial);
151 sr_err("Could not use port %s. Quitting.", conn);
154 send_shortcommand(serial, CMD_ID);
156 g_usleep(RESPONSE_DELAY_US);
158 if (sp_input_waiting(serial->data) == 0) {
159 sr_dbg("Didn't get any reply.");
163 ret = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
165 sr_err("Invalid reply (expected 4 bytes, got %d).", ret);
169 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
170 sr_err("Invalid reply (expected '1SLO' or '1ALS', got "
171 "'%c%c%c%c').", buf[0], buf[1], buf[2], buf[3]);
175 /* Definitely using the OLS protocol, check if it supports
176 * the metadata command.
178 send_shortcommand(serial, CMD_METADATA);
180 g_usleep(RESPONSE_DELAY_US);
182 if (sp_input_waiting(serial->data) != 0) {
184 sdi = get_metadata(serial);
187 /* Not an OLS -- some other board that uses the sump protocol. */
188 sr_info("Device does not support metadata.");
189 sdi = g_malloc0(sizeof(struct sr_dev_inst));
190 sdi->status = SR_ST_INACTIVE;
191 sdi->vendor = g_strdup("Sump");
192 sdi->model = g_strdup("Logic Analyzer");
193 sdi->version = g_strdup("v1.0");
195 for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
196 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
197 ols_channel_names[i]);
198 devc = ols_dev_new();
201 /* Configure samplerate and divider. */
202 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
203 sr_dbg("Failed to set default samplerate (%"PRIu64").",
205 sdi->inst_type = SR_INST_SERIAL;
208 drvc->instances = g_slist_append(drvc->instances, sdi);
209 devices = g_slist_append(devices, sdi);
211 serial_close(serial);
216 static GSList *dev_list(const struct sr_dev_driver *di)
218 return ((struct drv_context *)(di->context))->instances;
221 static int cleanup(const struct sr_dev_driver *di)
223 return std_dev_clear(di, NULL);
226 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
227 const struct sr_channel_group *cg)
229 struct dev_context *devc;
238 case SR_CONF_SAMPLERATE:
239 *data = g_variant_new_uint64(devc->cur_samplerate);
241 case SR_CONF_CAPTURE_RATIO:
242 *data = g_variant_new_uint64(devc->capture_ratio);
244 case SR_CONF_LIMIT_SAMPLES:
245 *data = g_variant_new_uint64(devc->limit_samples);
247 case SR_CONF_PATTERN_MODE:
248 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
249 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
250 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
251 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
253 *data = g_variant_new_string(STR_PATTERN_NONE);
256 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
265 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
266 const struct sr_channel_group *cg)
268 struct dev_context *devc;
276 if (sdi->status != SR_ST_ACTIVE)
277 return SR_ERR_DEV_CLOSED;
282 case SR_CONF_SAMPLERATE:
283 tmp_u64 = g_variant_get_uint64(data);
284 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
285 return SR_ERR_SAMPLERATE;
286 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
288 case SR_CONF_LIMIT_SAMPLES:
289 tmp_u64 = g_variant_get_uint64(data);
290 if (tmp_u64 < MIN_NUM_SAMPLES)
292 devc->limit_samples = tmp_u64;
295 case SR_CONF_CAPTURE_RATIO:
296 devc->capture_ratio = g_variant_get_uint64(data);
297 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
298 devc->capture_ratio = 0;
303 case SR_CONF_EXTERNAL_CLOCK:
304 if (g_variant_get_boolean(data)) {
305 sr_info("Enabling external clock.");
306 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
308 sr_info("Disabled external clock.");
309 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
313 case SR_CONF_PATTERN_MODE:
314 stropt = g_variant_get_string(data, NULL);
317 if (!strcmp(stropt, STR_PATTERN_NONE)) {
318 sr_info("Disabling test modes.");
320 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
321 sr_info("Enabling internal test mode.");
322 flag = FLAG_INTERNAL_TEST_MODE;
323 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
324 sr_info("Enabling external test mode.");
325 flag = FLAG_EXTERNAL_TEST_MODE;
329 if (flag != 0xffff) {
330 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
331 devc->flag_reg |= flag;
335 if (g_variant_get_boolean(data)) {
336 sr_info("Enabling channel swapping.");
337 devc->flag_reg |= FLAG_SWAP_CHANNELS;
339 sr_info("Disabling channel swapping.");
340 devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
346 if (g_variant_get_boolean(data)) {
347 sr_info("Enabling RLE.");
348 devc->flag_reg |= FLAG_RLE;
350 sr_info("Disabling RLE.");
351 devc->flag_reg &= ~FLAG_RLE;
362 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
363 const struct sr_channel_group *cg)
365 struct dev_context *devc;
366 GVariant *gvar, *grange[2];
368 int num_ols_changrp, i;
373 case SR_CONF_SCAN_OPTIONS:
374 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
375 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
377 case SR_CONF_DEVICE_OPTIONS:
379 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
380 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
382 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
383 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
385 case SR_CONF_SAMPLERATE:
386 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
387 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
388 ARRAY_SIZE(samplerates), sizeof(uint64_t));
389 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
390 *data = g_variant_builder_end(&gvb);
392 case SR_CONF_TRIGGER_MATCH:
393 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
394 trigger_matches, ARRAY_SIZE(trigger_matches),
397 case SR_CONF_PATTERN_MODE:
398 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
400 case SR_CONF_LIMIT_SAMPLES:
404 if (devc->flag_reg & FLAG_RLE)
406 if (devc->max_samples == 0)
407 /* Device didn't specify sample memory size in metadata. */
410 * Channel groups are turned off if no channels in that group are
411 * enabled, making more room for samples for the enabled group.
413 ols_channel_mask(sdi);
415 for (i = 0; i < 4; i++) {
416 if (devc->channel_mask & (0xff << (i * 8)))
419 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
421 grange[1] = g_variant_new_uint64(devc->max_samples / num_ols_changrp);
423 grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
424 *data = g_variant_new_tuple(grange, 2);
433 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
435 struct dev_context *devc;
436 struct sr_serial_dev_inst *serial;
442 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
443 arg[0] = devc->trigger_mask[stage] & 0xff;
444 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
445 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
446 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
447 if (send_longcommand(serial, cmd, arg) != SR_OK)
450 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
451 arg[0] = devc->trigger_value[stage] & 0xff;
452 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
453 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
454 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
455 if (send_longcommand(serial, cmd, arg) != SR_OK)
458 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
459 arg[0] = arg[1] = arg[3] = 0x00;
461 if (stage == devc->num_stages)
462 /* Last stage, fire when this one matches. */
463 arg[3] |= TRIGGER_START;
464 if (send_longcommand(serial, cmd, arg) != SR_OK)
470 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
473 struct dev_context *devc;
474 struct sr_serial_dev_inst *serial;
475 uint16_t samplecount, readcount, delaycount;
476 uint8_t ols_changrp_mask, arg[4];
480 if (sdi->status != SR_ST_ACTIVE)
481 return SR_ERR_DEV_CLOSED;
486 ols_channel_mask(sdi);
489 ols_changrp_mask = 0;
490 for (i = 0; i < 4; i++) {
491 if (devc->channel_mask & (0xff << (i * 8))) {
492 ols_changrp_mask |= (1 << i);
498 * Limit readcount to prevent reading past the end of the hardware
501 samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
502 readcount = samplecount / 4;
504 /* Rather read too many samples than too few. */
505 if (samplecount % 4 != 0)
508 /* Basic triggers. */
509 if (ols_convert_trigger(sdi) != SR_OK) {
510 sr_err("Failed to configure channels.");
513 if (devc->num_stages > 0) {
514 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
515 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
516 for (i = 0; i <= devc->num_stages; i++) {
517 sr_dbg("Setting OLS stage %d trigger.", i);
518 if ((ret = set_trigger(sdi, i)) != SR_OK)
522 /* No triggers configured, force trigger on first stage. */
523 sr_dbg("Forcing trigger at stage 0.");
524 if ((ret = set_trigger(sdi, 0)) != SR_OK)
526 delaycount = readcount;
530 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
531 devc->cur_samplerate, devc->cur_samplerate_divider);
532 arg[0] = devc->cur_samplerate_divider & 0xff;
533 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
534 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
536 if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
539 /* Send sample limit and pre/post-trigger capture ratio. */
540 sr_dbg("Setting sample limit %d, trigger point at %d",
541 (readcount - 1) * 4, (delaycount - 1) * 4);
542 arg[0] = ((readcount - 1) & 0xff);
543 arg[1] = ((readcount - 1) & 0xff00) >> 8;
544 arg[2] = ((delaycount - 1) & 0xff);
545 arg[3] = ((delaycount - 1) & 0xff00) >> 8;
546 if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
550 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
551 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
552 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
553 devc->flag_reg & FLAG_RLE ? "on" : "off",
554 devc->flag_reg & FLAG_FILTER ? "on": "off",
555 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
557 * Enable/disable OLS channel groups in the flag register according
558 * to the channel mask. 1 means "disable channel".
560 devc->flag_reg |= ~(ols_changrp_mask << 2) & 0x3c;
561 arg[0] = devc->flag_reg & 0xff;
562 arg[1] = devc->flag_reg >> 8;
563 arg[2] = arg[3] = 0x00;
564 if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
567 /* Start acquisition on the device. */
568 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
571 /* Reset all operational states. */
572 devc->rle_count = devc->num_transfers = 0;
573 devc->num_samples = devc->num_bytes = 0;
574 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
575 memset(devc->sample, 0, 4);
577 /* Send header packet to the session bus. */
578 std_session_send_df_header(cb_data, LOG_PREFIX);
580 serial_source_add(sdi->session, serial, G_IO_IN, -1,
581 ols_receive_data, cb_data);
586 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
590 abort_acquisition(sdi);
595 SR_PRIV struct sr_dev_driver ols_driver_info = {
597 .longname = "Openbench Logic Sniffer",
602 .dev_list = dev_list,
604 .config_get = config_get,
605 .config_set = config_set,
606 .config_list = config_list,
607 .dev_open = std_serial_dev_open,
608 .dev_close = std_serial_dev_close,
609 .dev_acquisition_start = dev_acquisition_start,
610 .dev_acquisition_stop = dev_acquisition_stop,