2 * This file is part of the sigrok 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/>.
22 #define SERIALCOMM "115200/8n1"
24 static const int32_t hwopts[] = {
29 static const int32_t hwcaps[] = {
30 SR_CONF_LOGIC_ANALYZER,
33 SR_CONF_CAPTURE_RATIO,
34 SR_CONF_LIMIT_SAMPLES,
38 /* Probes are numbered 0-31 (on the PCB silkscreen). */
39 SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
40 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
41 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
42 "24", "25", "26", "27", "28", "29", "30", "31",
46 /* Default supported samplerates, can be overridden by device metadata. */
47 static const uint64_t samplerates[] = {
53 SR_PRIV struct sr_dev_driver ols_driver_info;
54 static struct sr_dev_driver *di = &ols_driver_info;
56 static int hw_init(struct sr_context *sr_ctx)
58 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
61 static GSList *hw_scan(GSList *options)
63 struct sr_config *src;
64 struct sr_dev_inst *sdi;
65 struct drv_context *drvc;
66 struct dev_context *devc;
67 struct sr_probe *probe;
68 struct sr_serial_dev_inst *serial;
72 const char *conn, *serialcomm;
81 conn = serialcomm = NULL;
82 for (l = options; l; l = l->next) {
86 conn = g_variant_get_string(src->data, NULL);
88 case SR_CONF_SERIALCOMM:
89 serialcomm = g_variant_get_string(src->data, NULL);
96 if (serialcomm == NULL)
97 serialcomm = SERIALCOMM;
99 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
102 /* The discovery procedure is like this: first send the Reset
103 * command (0x00) 5 times, since the device could be anywhere
104 * in a 5-byte command. Then send the ID command (0x02).
105 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
108 sr_info("Probing %s.", conn);
109 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
113 for (i = 0; i < 5; i++) {
114 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
115 sr_err("Port %s is not writable.", conn);
120 serial_close(serial);
121 sr_err("Could not use port %s. Quitting.", conn);
124 send_shortcommand(serial, CMD_ID);
126 /* Wait 10ms for a response. */
129 probefd.fd = serial->fd;
130 probefd.events = G_IO_IN;
131 g_poll(&probefd, 1, 1);
133 if (probefd.revents != G_IO_IN)
135 if (serial_read(serial, buf, 4) != 4)
137 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
140 /* Definitely using the OLS protocol, check if it supports
141 * the metadata command.
143 send_shortcommand(serial, CMD_METADATA);
144 if (g_poll(&probefd, 1, 10) > 0) {
146 sdi = get_metadata(serial);
150 /* Not an OLS -- some other board that uses the sump protocol. */
151 sr_info("Device does not support metadata.");
152 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
153 "Sump", "Logic Analyzer", "v1.0");
155 for (i = 0; i < 32; i++) {
156 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
157 ols_probe_names[i])))
159 sdi->probes = g_slist_append(sdi->probes, probe);
161 devc = ols_dev_new();
164 /* Configure samplerate and divider. */
165 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
166 sr_dbg("Failed to set default samplerate (%"PRIu64").",
168 /* Clear trigger masks, values and stages. */
169 ols_configure_probes(sdi);
170 devc->serial = serial;
172 drvc->instances = g_slist_append(drvc->instances, sdi);
173 devices = g_slist_append(devices, sdi);
175 serial_close(serial);
180 static GSList *hw_dev_list(void)
182 return ((struct drv_context *)(di->priv))->instances;
185 static int hw_dev_open(struct sr_dev_inst *sdi)
187 struct dev_context *devc;
191 if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
194 sdi->status = SR_ST_ACTIVE;
199 static int hw_dev_close(struct sr_dev_inst *sdi)
201 struct dev_context *devc;
205 if (devc->serial && devc->serial->fd != -1) {
206 serial_close(devc->serial);
207 sdi->status = SR_ST_INACTIVE;
213 static int hw_cleanup(void)
216 struct sr_dev_inst *sdi;
217 struct drv_context *drvc;
218 struct dev_context *devc;
221 if (!(drvc = di->priv))
224 /* Properly close and free all devices. */
225 for (l = drvc->instances; l; l = l->next) {
226 if (!(sdi = l->data)) {
227 /* Log error, but continue cleaning up the rest. */
228 sr_err("%s: sdi was NULL, continuing", __func__);
232 if (!(devc = sdi->priv)) {
233 /* Log error, but continue cleaning up the rest. */
234 sr_err("%s: sdi->priv was NULL, continuing", __func__);
239 sr_serial_dev_inst_free(devc->serial);
240 sr_dev_inst_free(sdi);
242 g_slist_free(drvc->instances);
243 drvc->instances = NULL;
248 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
250 struct dev_context *devc;
257 case SR_CONF_SAMPLERATE:
258 *data = g_variant_new_uint64(devc->cur_samplerate);
260 case SR_CONF_CAPTURE_RATIO:
261 *data = g_variant_new_uint64(devc->capture_ratio);
263 case SR_CONF_LIMIT_SAMPLES:
264 *data = g_variant_new_uint64(devc->limit_samples);
267 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
276 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
278 struct dev_context *devc;
285 case SR_CONF_SAMPLERATE:
286 tmp_u64 = g_variant_get_uint64(data);
287 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
288 return SR_ERR_SAMPLERATE;
289 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
291 case SR_CONF_LIMIT_SAMPLES:
292 tmp_u64 = g_variant_get_uint64(data);
293 if (tmp_u64 < MIN_NUM_SAMPLES)
295 devc->limit_samples = tmp_u64;
298 case SR_CONF_CAPTURE_RATIO:
299 devc->capture_ratio = g_variant_get_uint64(data);
300 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
301 devc->capture_ratio = 0;
307 if (g_variant_get_boolean(data)) {
308 sr_info("Enabling RLE.");
309 devc->flag_reg |= FLAG_RLE;
311 sr_info("Disabling RLE.");
312 devc->flag_reg &= ~FLAG_RLE;
323 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
331 case SR_CONF_SCAN_OPTIONS:
332 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
333 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
335 case SR_CONF_DEVICE_OPTIONS:
336 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
337 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
339 case SR_CONF_SAMPLERATE:
340 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
341 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
342 ARRAY_SIZE(samplerates), sizeof(uint64_t));
343 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
344 *data = g_variant_builder_end(&gvb);
346 case SR_CONF_TRIGGER_TYPE:
347 *data = g_variant_new_string(TRIGGER_TYPE);
356 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
359 struct dev_context *devc;
360 uint32_t trigger_config[4];
362 uint16_t readcount, delaycount;
363 uint8_t changrp_mask;
369 if (sdi->status != SR_ST_ACTIVE)
372 if (ols_configure_probes(sdi) != SR_OK) {
373 sr_err("Failed to configure probes.");
378 * Enable/disable channel groups in the flag register according to the
379 * probe mask. Calculate this here, because num_channels is needed
380 * to limit readcount.
384 for (i = 0; i < 4; i++) {
385 if (devc->probe_mask & (0xff << (i * 8))) {
386 changrp_mask |= (1 << i);
392 * Limit readcount to prevent reading past the end of the hardware
395 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
397 memset(trigger_config, 0, 16);
398 trigger_config[devc->num_stages - 1] |= 0x08;
399 if (devc->trigger_mask[0]) {
400 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
401 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
403 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0,
404 reverse32(devc->trigger_mask[0])) != SR_OK)
406 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0,
407 reverse32(devc->trigger_value[0])) != SR_OK)
409 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0,
410 trigger_config[0]) != SR_OK)
413 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_1,
414 reverse32(devc->trigger_mask[1])) != SR_OK)
416 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_1,
417 reverse32(devc->trigger_value[1])) != SR_OK)
419 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_1,
420 trigger_config[1]) != SR_OK)
423 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_2,
424 reverse32(devc->trigger_mask[2])) != SR_OK)
426 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_2,
427 reverse32(devc->trigger_value[2])) != SR_OK)
429 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_2,
430 trigger_config[2]) != SR_OK)
433 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_3,
434 reverse32(devc->trigger_mask[3])) != SR_OK)
436 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_3,
437 reverse32(devc->trigger_value[3])) != SR_OK)
439 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_3,
440 trigger_config[3]) != SR_OK)
443 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0,
444 devc->trigger_mask[0]) != SR_OK)
446 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0,
447 devc->trigger_value[0]) != SR_OK)
449 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0,
450 0x00000008) != SR_OK)
452 delaycount = readcount;
455 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
456 "demux %s)", devc->cur_samplerate, devc->cur_samplerate_divider,
457 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
458 if (send_longcommand(devc->serial, CMD_SET_DIVIDER,
459 reverse32(devc->cur_samplerate_divider)) != SR_OK)
462 /* Send sample limit and pre/post-trigger capture ratio. */
463 data = ((readcount - 1) & 0xffff) << 16;
464 data |= (delaycount - 1) & 0xffff;
465 if (send_longcommand(devc->serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
468 /* The flag register wants them here, and 1 means "disable channel". */
469 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
470 devc->flag_reg |= FLAG_FILTER;
472 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
473 if (send_longcommand(devc->serial, CMD_SET_FLAGS, data) != SR_OK)
476 /* Start acquisition on the device. */
477 if (send_shortcommand(devc->serial, CMD_RUN) != SR_OK)
480 /* Reset all operational states. */
481 devc->num_transfers = devc->num_samples = devc->num_bytes = 0;
483 /* Send header packet to the session bus. */
484 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
486 sr_source_add(devc->serial->fd, G_IO_IN, -1, ols_receive_data,
492 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
494 /* Avoid compiler warnings. */
497 abort_acquisition(sdi);
502 SR_PRIV struct sr_dev_driver ols_driver_info = {
504 .longname = "Openbench Logic Sniffer",
507 .cleanup = hw_cleanup,
509 .dev_list = hw_dev_list,
510 .dev_clear = hw_cleanup,
511 .config_get = config_get,
512 .config_set = config_set,
513 .config_list = config_list,
514 .dev_open = hw_dev_open,
515 .dev_close = hw_dev_close,
516 .dev_acquisition_start = hw_dev_acquisition_start,
517 .dev_acquisition_stop = hw_dev_acquisition_stop,