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/>.
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 static GSList *scan(struct sr_dev_driver *di, GSList *options)
90 struct sr_config *src;
91 struct sr_dev_inst *sdi;
92 struct sr_serial_dev_inst *serial;
96 const char *conn, *serialcomm;
99 conn = serialcomm = NULL;
100 for (l = options; l; l = l->next) {
104 conn = g_variant_get_string(src->data, NULL);
106 case SR_CONF_SERIALCOMM:
107 serialcomm = g_variant_get_string(src->data, NULL);
115 serialcomm = SERIALCOMM;
117 serial = sr_serial_dev_inst_new(conn, serialcomm);
119 /* The discovery procedure is like this: first send the Reset
120 * command (0x00) 5 times, since the device could be anywhere
121 * in a 5-byte command. Then send the ID command (0x02).
122 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
125 sr_info("Probing %s.", conn);
126 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
129 if (ols_send_reset(serial) != SR_OK) {
130 serial_close(serial);
131 sr_err("Could not use port %s. Quitting.", conn);
134 send_shortcommand(serial, CMD_ID);
136 g_usleep(RESPONSE_DELAY_US);
138 if (sp_input_waiting(serial->data) == 0) {
139 sr_dbg("Didn't get any reply.");
143 ret = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
145 sr_err("Invalid reply (expected 4 bytes, got %d).", ret);
149 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
150 sr_err("Invalid reply (expected '1SLO' or '1ALS', got "
151 "'%c%c%c%c').", buf[0], buf[1], buf[2], buf[3]);
155 /* Definitely using the OLS protocol, check if it supports
156 * the metadata command.
158 send_shortcommand(serial, CMD_METADATA);
160 g_usleep(RESPONSE_DELAY_US);
162 if (sp_input_waiting(serial->data) != 0) {
164 sdi = get_metadata(serial);
166 /* Not an OLS -- some other board that uses the sump protocol. */
167 sr_info("Device does not support metadata.");
168 sdi = g_malloc0(sizeof(struct sr_dev_inst));
169 sdi->status = SR_ST_INACTIVE;
170 sdi->vendor = g_strdup("Sump");
171 sdi->model = g_strdup("Logic Analyzer");
172 sdi->version = g_strdup("v1.0");
173 for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
174 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
175 ols_channel_names[i]);
176 sdi->priv = ols_dev_new();
178 /* Configure samplerate and divider. */
179 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
180 sr_dbg("Failed to set default samplerate (%"PRIu64").",
182 sdi->inst_type = SR_INST_SERIAL;
185 serial_close(serial);
187 return std_scan_complete(di, g_slist_append(NULL, sdi));
190 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
191 const struct sr_channel_group *cg)
193 struct dev_context *devc;
202 case SR_CONF_SAMPLERATE:
203 *data = g_variant_new_uint64(devc->cur_samplerate);
205 case SR_CONF_CAPTURE_RATIO:
206 *data = g_variant_new_uint64(devc->capture_ratio);
208 case SR_CONF_LIMIT_SAMPLES:
209 *data = g_variant_new_uint64(devc->limit_samples);
211 case SR_CONF_PATTERN_MODE:
212 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
213 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
214 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
215 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
217 *data = g_variant_new_string(STR_PATTERN_NONE);
220 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
229 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
230 const struct sr_channel_group *cg)
232 struct dev_context *devc;
243 case SR_CONF_SAMPLERATE:
244 tmp_u64 = g_variant_get_uint64(data);
245 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
246 return SR_ERR_SAMPLERATE;
247 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
249 case SR_CONF_LIMIT_SAMPLES:
250 tmp_u64 = g_variant_get_uint64(data);
251 if (tmp_u64 < MIN_NUM_SAMPLES)
253 devc->limit_samples = tmp_u64;
256 case SR_CONF_CAPTURE_RATIO:
257 devc->capture_ratio = g_variant_get_uint64(data);
258 if (devc->capture_ratio < 0 || devc->capture_ratio > 100)
263 case SR_CONF_EXTERNAL_CLOCK:
264 if (g_variant_get_boolean(data)) {
265 sr_info("Enabling external clock.");
266 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
268 sr_info("Disabled external clock.");
269 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
273 case SR_CONF_PATTERN_MODE:
274 stropt = g_variant_get_string(data, NULL);
277 if (!strcmp(stropt, STR_PATTERN_NONE)) {
278 sr_info("Disabling test modes.");
280 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
281 sr_info("Enabling internal test mode.");
282 flag = FLAG_INTERNAL_TEST_MODE;
283 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
284 sr_info("Enabling external test mode.");
285 flag = FLAG_EXTERNAL_TEST_MODE;
289 if (flag != 0xffff) {
290 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
291 devc->flag_reg |= flag;
295 if (g_variant_get_boolean(data)) {
296 sr_info("Enabling channel swapping.");
297 devc->flag_reg |= FLAG_SWAP_CHANNELS;
299 sr_info("Disabling channel swapping.");
300 devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
306 if (g_variant_get_boolean(data)) {
307 sr_info("Enabling RLE.");
308 devc->flag_reg |= FLAG_RLE;
310 sr_info("Disabling RLE.");
311 devc->flag_reg &= ~FLAG_RLE;
322 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
323 const struct sr_channel_group *cg)
325 struct dev_context *devc;
326 GVariant *gvar, *grange[2];
328 int num_ols_changrp, i;
333 case SR_CONF_SCAN_OPTIONS:
334 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
335 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
337 case SR_CONF_DEVICE_OPTIONS:
339 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
340 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
342 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
343 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
345 case SR_CONF_SAMPLERATE:
346 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
347 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
348 ARRAY_SIZE(samplerates), sizeof(uint64_t));
349 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
350 *data = g_variant_builder_end(&gvb);
352 case SR_CONF_TRIGGER_MATCH:
353 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
354 trigger_matches, ARRAY_SIZE(trigger_matches),
357 case SR_CONF_PATTERN_MODE:
358 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
360 case SR_CONF_LIMIT_SAMPLES:
364 if (devc->flag_reg & FLAG_RLE)
366 if (devc->max_samples == 0)
367 /* Device didn't specify sample memory size in metadata. */
370 * Channel groups are turned off if no channels in that group are
371 * enabled, making more room for samples for the enabled group.
373 ols_channel_mask(sdi);
375 for (i = 0; i < 4; i++) {
376 if (devc->channel_mask & (0xff << (i * 8)))
379 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
381 grange[1] = g_variant_new_uint64(devc->max_samples / num_ols_changrp);
383 grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
384 *data = g_variant_new_tuple(grange, 2);
393 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
395 struct dev_context *devc;
396 struct sr_serial_dev_inst *serial;
402 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
403 arg[0] = devc->trigger_mask[stage] & 0xff;
404 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
405 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
406 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
407 if (send_longcommand(serial, cmd, arg) != SR_OK)
410 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
411 arg[0] = devc->trigger_value[stage] & 0xff;
412 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
413 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
414 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
415 if (send_longcommand(serial, cmd, arg) != SR_OK)
418 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
419 arg[0] = arg[1] = arg[3] = 0x00;
421 if (stage == devc->num_stages)
422 /* Last stage, fire when this one matches. */
423 arg[3] |= TRIGGER_START;
424 if (send_longcommand(serial, cmd, arg) != SR_OK)
430 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
432 struct dev_context *devc;
433 struct sr_serial_dev_inst *serial;
434 uint16_t samplecount, readcount, delaycount;
435 uint8_t ols_changrp_mask, arg[4];
442 ols_channel_mask(sdi);
445 ols_changrp_mask = 0;
446 for (i = 0; i < 4; i++) {
447 if (devc->channel_mask & (0xff << (i * 8))) {
448 ols_changrp_mask |= (1 << i);
454 * Limit readcount to prevent reading past the end of the hardware
457 samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
458 readcount = samplecount / 4;
460 /* Rather read too many samples than too few. */
461 if (samplecount % 4 != 0)
464 /* Basic triggers. */
465 if (ols_convert_trigger(sdi) != SR_OK) {
466 sr_err("Failed to configure channels.");
469 if (devc->num_stages > 0) {
471 * According to http://mygizmos.org/ols/Logic-Sniffer-FPGA-Spec.pdf
472 * reset command must be send prior each arm command
474 sr_dbg("Send reset command before trigger configure");
475 if (ols_send_reset(serial) != SR_OK)
478 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
479 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
480 for (i = 0; i <= devc->num_stages; i++) {
481 sr_dbg("Setting OLS stage %d trigger.", i);
482 if ((ret = set_trigger(sdi, i)) != SR_OK)
486 /* No triggers configured, force trigger on first stage. */
487 sr_dbg("Forcing trigger at stage 0.");
488 if ((ret = set_trigger(sdi, 0)) != SR_OK)
490 delaycount = readcount;
494 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
495 devc->cur_samplerate, devc->cur_samplerate_divider);
496 arg[0] = devc->cur_samplerate_divider & 0xff;
497 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
498 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
500 if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
503 /* Send sample limit and pre/post-trigger capture ratio. */
504 sr_dbg("Setting sample limit %d, trigger point at %d",
505 (readcount - 1) * 4, (delaycount - 1) * 4);
506 arg[0] = ((readcount - 1) & 0xff);
507 arg[1] = ((readcount - 1) & 0xff00) >> 8;
508 arg[2] = ((delaycount - 1) & 0xff);
509 arg[3] = ((delaycount - 1) & 0xff00) >> 8;
510 if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
514 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
515 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
516 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
517 devc->flag_reg & FLAG_RLE ? "on" : "off",
518 devc->flag_reg & FLAG_FILTER ? "on": "off",
519 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
521 * Enable/disable OLS channel groups in the flag register according
522 * to the channel mask. 1 means "disable channel".
524 devc->flag_reg |= ~(ols_changrp_mask << 2) & 0x3c;
525 arg[0] = devc->flag_reg & 0xff;
526 arg[1] = devc->flag_reg >> 8;
527 arg[2] = arg[3] = 0x00;
528 if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
531 /* Start acquisition on the device. */
532 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
535 /* Reset all operational states. */
536 devc->rle_count = devc->num_transfers = 0;
537 devc->num_samples = devc->num_bytes = 0;
538 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
539 memset(devc->sample, 0, 4);
541 std_session_send_df_header(sdi);
543 /* If the device stops sending for longer than it takes to send a byte,
544 * that means it's finished. But wait at least 100 ms to be safe.
546 serial_source_add(sdi->session, serial, G_IO_IN, 100,
547 ols_receive_data, (struct sr_dev_inst *)sdi);
552 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
554 abort_acquisition(sdi);
559 static struct sr_dev_driver ols_driver_info = {
561 .longname = "Openbench Logic Sniffer",
564 .cleanup = std_cleanup,
566 .dev_list = std_dev_list,
568 .config_get = config_get,
569 .config_set = config_set,
570 .config_list = config_list,
571 .dev_open = std_serial_dev_open,
572 .dev_close = std_serial_dev_close,
573 .dev_acquisition_start = dev_acquisition_start,
574 .dev_acquisition_stop = dev_acquisition_stop,
577 SR_REGISTER_DEV_DRIVER(ols_driver_info);