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 SR_PRIV struct sr_dev_driver ols_driver_info;
90 static GSList *scan(struct sr_dev_driver *di, GSList *options)
92 struct sr_config *src;
93 struct sr_dev_inst *sdi;
94 struct drv_context *drvc;
95 struct sr_serial_dev_inst *serial;
99 const char *conn, *serialcomm;
106 conn = serialcomm = NULL;
107 for (l = options; l; l = l->next) {
111 conn = g_variant_get_string(src->data, NULL);
113 case SR_CONF_SERIALCOMM:
114 serialcomm = g_variant_get_string(src->data, NULL);
122 serialcomm = SERIALCOMM;
124 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) != 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 g_usleep(RESPONSE_DELAY_US);
152 if (sp_input_waiting(serial->data) == 0) {
153 sr_dbg("Didn't get any reply.");
157 ret = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
159 sr_err("Invalid reply (expected 4 bytes, got %d).", ret);
163 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
164 sr_err("Invalid reply (expected '1SLO' or '1ALS', got "
165 "'%c%c%c%c').", buf[0], buf[1], buf[2], buf[3]);
169 /* Definitely using the OLS protocol, check if it supports
170 * the metadata command.
172 send_shortcommand(serial, CMD_METADATA);
174 g_usleep(RESPONSE_DELAY_US);
176 if (sp_input_waiting(serial->data) != 0) {
178 sdi = get_metadata(serial);
180 /* Not an OLS -- some other board that uses the sump protocol. */
181 sr_info("Device does not support metadata.");
182 sdi = g_malloc0(sizeof(struct sr_dev_inst));
183 sdi->status = SR_ST_INACTIVE;
184 sdi->vendor = g_strdup("Sump");
185 sdi->model = g_strdup("Logic Analyzer");
186 sdi->version = g_strdup("v1.0");
188 for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
189 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
190 ols_channel_names[i]);
191 sdi->priv = ols_dev_new();
193 /* Configure samplerate and divider. */
194 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
195 sr_dbg("Failed to set default samplerate (%"PRIu64").",
197 sdi->inst_type = SR_INST_SERIAL;
200 drvc->instances = g_slist_append(drvc->instances, sdi);
201 devices = g_slist_append(devices, sdi);
203 serial_close(serial);
208 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
209 const struct sr_channel_group *cg)
211 struct dev_context *devc;
220 case SR_CONF_SAMPLERATE:
221 *data = g_variant_new_uint64(devc->cur_samplerate);
223 case SR_CONF_CAPTURE_RATIO:
224 *data = g_variant_new_uint64(devc->capture_ratio);
226 case SR_CONF_LIMIT_SAMPLES:
227 *data = g_variant_new_uint64(devc->limit_samples);
229 case SR_CONF_PATTERN_MODE:
230 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
231 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
232 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
233 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
235 *data = g_variant_new_string(STR_PATTERN_NONE);
238 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
247 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
248 const struct sr_channel_group *cg)
250 struct dev_context *devc;
258 if (sdi->status != SR_ST_ACTIVE)
259 return SR_ERR_DEV_CLOSED;
264 case SR_CONF_SAMPLERATE:
265 tmp_u64 = g_variant_get_uint64(data);
266 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
267 return SR_ERR_SAMPLERATE;
268 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
270 case SR_CONF_LIMIT_SAMPLES:
271 tmp_u64 = g_variant_get_uint64(data);
272 if (tmp_u64 < MIN_NUM_SAMPLES)
274 devc->limit_samples = tmp_u64;
277 case SR_CONF_CAPTURE_RATIO:
278 devc->capture_ratio = g_variant_get_uint64(data);
279 if (devc->capture_ratio < 0 || devc->capture_ratio > 100)
284 case SR_CONF_EXTERNAL_CLOCK:
285 if (g_variant_get_boolean(data)) {
286 sr_info("Enabling external clock.");
287 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
289 sr_info("Disabled external clock.");
290 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
294 case SR_CONF_PATTERN_MODE:
295 stropt = g_variant_get_string(data, NULL);
298 if (!strcmp(stropt, STR_PATTERN_NONE)) {
299 sr_info("Disabling test modes.");
301 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
302 sr_info("Enabling internal test mode.");
303 flag = FLAG_INTERNAL_TEST_MODE;
304 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
305 sr_info("Enabling external test mode.");
306 flag = FLAG_EXTERNAL_TEST_MODE;
310 if (flag != 0xffff) {
311 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
312 devc->flag_reg |= flag;
316 if (g_variant_get_boolean(data)) {
317 sr_info("Enabling channel swapping.");
318 devc->flag_reg |= FLAG_SWAP_CHANNELS;
320 sr_info("Disabling channel swapping.");
321 devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
327 if (g_variant_get_boolean(data)) {
328 sr_info("Enabling RLE.");
329 devc->flag_reg |= FLAG_RLE;
331 sr_info("Disabling RLE.");
332 devc->flag_reg &= ~FLAG_RLE;
343 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
344 const struct sr_channel_group *cg)
346 struct dev_context *devc;
347 GVariant *gvar, *grange[2];
349 int num_ols_changrp, i;
354 case SR_CONF_SCAN_OPTIONS:
355 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
356 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
358 case SR_CONF_DEVICE_OPTIONS:
360 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
361 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
363 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
364 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
366 case SR_CONF_SAMPLERATE:
367 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
368 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
369 ARRAY_SIZE(samplerates), sizeof(uint64_t));
370 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
371 *data = g_variant_builder_end(&gvb);
373 case SR_CONF_TRIGGER_MATCH:
374 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
375 trigger_matches, ARRAY_SIZE(trigger_matches),
378 case SR_CONF_PATTERN_MODE:
379 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
381 case SR_CONF_LIMIT_SAMPLES:
385 if (devc->flag_reg & FLAG_RLE)
387 if (devc->max_samples == 0)
388 /* Device didn't specify sample memory size in metadata. */
391 * Channel groups are turned off if no channels in that group are
392 * enabled, making more room for samples for the enabled group.
394 ols_channel_mask(sdi);
396 for (i = 0; i < 4; i++) {
397 if (devc->channel_mask & (0xff << (i * 8)))
400 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
402 grange[1] = g_variant_new_uint64(devc->max_samples / num_ols_changrp);
404 grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
405 *data = g_variant_new_tuple(grange, 2);
414 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
416 struct dev_context *devc;
417 struct sr_serial_dev_inst *serial;
423 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
424 arg[0] = devc->trigger_mask[stage] & 0xff;
425 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
426 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
427 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
428 if (send_longcommand(serial, cmd, arg) != SR_OK)
431 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
432 arg[0] = devc->trigger_value[stage] & 0xff;
433 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
434 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
435 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
436 if (send_longcommand(serial, cmd, arg) != SR_OK)
439 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
440 arg[0] = arg[1] = arg[3] = 0x00;
442 if (stage == devc->num_stages)
443 /* Last stage, fire when this one matches. */
444 arg[3] |= TRIGGER_START;
445 if (send_longcommand(serial, cmd, arg) != SR_OK)
451 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 ols_changrp_mask, arg[4];
460 if (sdi->status != SR_ST_ACTIVE)
461 return SR_ERR_DEV_CLOSED;
466 ols_channel_mask(sdi);
469 ols_changrp_mask = 0;
470 for (i = 0; i < 4; i++) {
471 if (devc->channel_mask & (0xff << (i * 8))) {
472 ols_changrp_mask |= (1 << i);
478 * Limit readcount to prevent reading past the end of the hardware
481 samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
482 readcount = samplecount / 4;
484 /* Rather read too many samples than too few. */
485 if (samplecount % 4 != 0)
488 /* Basic triggers. */
489 if (ols_convert_trigger(sdi) != SR_OK) {
490 sr_err("Failed to configure channels.");
493 if (devc->num_stages > 0) {
494 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
495 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
496 for (i = 0; i <= devc->num_stages; i++) {
497 sr_dbg("Setting OLS stage %d trigger.", i);
498 if ((ret = set_trigger(sdi, i)) != SR_OK)
502 /* No triggers configured, force trigger on first stage. */
503 sr_dbg("Forcing trigger at stage 0.");
504 if ((ret = set_trigger(sdi, 0)) != SR_OK)
506 delaycount = readcount;
510 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
511 devc->cur_samplerate, devc->cur_samplerate_divider);
512 arg[0] = devc->cur_samplerate_divider & 0xff;
513 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
514 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
516 if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
519 /* Send sample limit and pre/post-trigger capture ratio. */
520 sr_dbg("Setting sample limit %d, trigger point at %d",
521 (readcount - 1) * 4, (delaycount - 1) * 4);
522 arg[0] = ((readcount - 1) & 0xff);
523 arg[1] = ((readcount - 1) & 0xff00) >> 8;
524 arg[2] = ((delaycount - 1) & 0xff);
525 arg[3] = ((delaycount - 1) & 0xff00) >> 8;
526 if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
530 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
531 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
532 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
533 devc->flag_reg & FLAG_RLE ? "on" : "off",
534 devc->flag_reg & FLAG_FILTER ? "on": "off",
535 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
537 * Enable/disable OLS channel groups in the flag register according
538 * to the channel mask. 1 means "disable channel".
540 devc->flag_reg |= ~(ols_changrp_mask << 2) & 0x3c;
541 arg[0] = devc->flag_reg & 0xff;
542 arg[1] = devc->flag_reg >> 8;
543 arg[2] = arg[3] = 0x00;
544 if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
547 /* Start acquisition on the device. */
548 if (send_shortcommand(serial, CMD_RUN) != SR_OK)
551 /* Reset all operational states. */
552 devc->rle_count = devc->num_transfers = 0;
553 devc->num_samples = devc->num_bytes = 0;
554 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
555 memset(devc->sample, 0, 4);
557 std_session_send_df_header(sdi, LOG_PREFIX);
559 /* If the device stops sending for longer than it takes to send a byte,
560 * that means it's finished. But wait at least 100 ms to be safe.
562 serial_source_add(sdi->session, serial, G_IO_IN, 100,
563 ols_receive_data, (struct sr_dev_inst *)sdi);
568 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
570 abort_acquisition(sdi);
575 SR_PRIV struct sr_dev_driver ols_driver_info = {
577 .longname = "Openbench Logic Sniffer",
580 .cleanup = std_cleanup,
582 .dev_list = std_dev_list,
584 .config_get = config_get,
585 .config_set = config_set,
586 .config_list = config_list,
587 .dev_open = std_serial_dev_open,
588 .dev_close = std_serial_dev_close,
589 .dev_acquisition_start = dev_acquisition_start,
590 .dev_acquisition_stop = dev_acquisition_stop,