2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 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 int hwopts[] = {
30 static const int hwcaps[] = {
31 SR_CONF_LOGIC_ANALYZER,
33 SR_CONF_CAPTURE_RATIO,
34 SR_CONF_LIMIT_SAMPLES,
39 /* Probes are numbered 0-31 (on the PCB silkscreen). */
40 SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
41 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
42 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
43 "24", "25", "26", "27", "28", "29", "30", "31",
47 /* Default supported samplerates, can be overridden by device metadata. */
48 static const struct sr_samplerates samplerates = {
55 SR_PRIV struct sr_dev_driver ols_driver_info;
56 static struct sr_dev_driver *di = &ols_driver_info;
58 static int hw_init(struct sr_context *sr_ctx)
60 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
63 static GSList *hw_scan(GSList *options)
65 struct sr_config *src;
66 struct sr_dev_inst *sdi;
67 struct drv_context *drvc;
68 struct dev_context *devc;
69 struct sr_probe *probe;
70 struct sr_serial_dev_inst *serial;
74 const char *conn, *serialcomm;
83 conn = serialcomm = NULL;
84 for (l = options; l; l = l->next) {
90 case SR_CONF_SERIALCOMM:
91 serialcomm = src->value;
98 if (serialcomm == NULL)
99 serialcomm = SERIALCOMM;
101 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
104 /* The discovery procedure is like this: first send the Reset
105 * command (0x00) 5 times, since the device could be anywhere
106 * in a 5-byte command. Then send the ID command (0x02).
107 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
110 sr_info("Probing %s.", conn);
111 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
115 for (i = 0; i < 5; i++) {
116 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
117 sr_err("Port %s is not writable.", conn);
122 serial_close(serial);
123 sr_err("Could not use port %s. Quitting.", conn);
126 send_shortcommand(serial, CMD_ID);
128 /* Wait 10ms for a response. */
131 probefd.fd = serial->fd;
132 probefd.events = G_IO_IN;
133 g_poll(&probefd, 1, 1);
135 if (probefd.revents != G_IO_IN)
137 if (serial_read(serial, buf, 4) != 4)
139 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
142 /* Definitely using the OLS protocol, check if it supports
143 * the metadata command.
145 send_shortcommand(serial, CMD_METADATA);
146 if (g_poll(&probefd, 1, 10) > 0) {
148 sdi = get_metadata(serial);
152 /* Not an OLS -- some other board that uses the sump protocol. */
153 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
154 "Sump", "Logic Analyzer", "v1.0");
156 devc = ols_dev_new();
157 for (i = 0; i < 32; i++) {
158 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
159 ols_probe_names[i])))
161 sdi->probes = g_slist_append(sdi->probes, probe);
165 devc->serial = serial;
166 drvc->instances = g_slist_append(drvc->instances, sdi);
167 devices = g_slist_append(devices, sdi);
169 serial_close(serial);
174 static GSList *hw_dev_list(void)
176 return ((struct drv_context *)(di->priv))->instances;
179 static int hw_dev_open(struct sr_dev_inst *sdi)
181 struct dev_context *devc;
185 if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
188 sdi->status = SR_ST_ACTIVE;
193 static int hw_dev_close(struct sr_dev_inst *sdi)
195 struct dev_context *devc;
199 if (devc->serial && devc->serial->fd != -1) {
200 serial_close(devc->serial);
201 sdi->status = SR_ST_INACTIVE;
207 static int hw_cleanup(void)
210 struct sr_dev_inst *sdi;
211 struct drv_context *drvc;
212 struct dev_context *devc;
215 if (!(drvc = di->priv))
218 /* Properly close and free all devices. */
219 for (l = drvc->instances; l; l = l->next) {
220 if (!(sdi = l->data)) {
221 /* Log error, but continue cleaning up the rest. */
222 sr_err("%s: sdi was NULL, continuing", __func__);
226 if (!(devc = sdi->priv)) {
227 /* Log error, but continue cleaning up the rest. */
228 sr_err("%s: sdi->priv was NULL, continuing", __func__);
233 sr_serial_dev_inst_free(devc->serial);
234 sr_dev_inst_free(sdi);
236 g_slist_free(drvc->instances);
237 drvc->instances = NULL;
242 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
244 struct dev_context *devc;
247 case SR_CONF_SAMPLERATE:
250 *data = &devc->cur_samplerate;
261 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
263 struct dev_context *devc;
265 const uint64_t *tmp_u64;
269 if (sdi->status != SR_ST_ACTIVE)
273 case SR_CONF_SAMPLERATE:
274 ret = ols_set_samplerate(sdi, *(const uint64_t *)value,
277 case SR_CONF_LIMIT_SAMPLES:
279 if (*tmp_u64 < MIN_NUM_SAMPLES)
281 if (*tmp_u64 > devc->max_samples)
282 sr_err("Sample limit exceeds hardware maximum.");
283 devc->limit_samples = *tmp_u64;
284 sr_info("Sample limit is %" PRIu64 ".", devc->limit_samples);
287 case SR_CONF_CAPTURE_RATIO:
288 devc->capture_ratio = *(const uint64_t *)value;
289 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
290 devc->capture_ratio = 0;
297 sr_info("Enabling RLE.");
298 devc->flag_reg |= FLAG_RLE;
309 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
315 case SR_CONF_SCAN_OPTIONS:
318 case SR_CONF_DEVICE_OPTIONS:
321 case SR_CONF_SAMPLERATE:
322 *data = &samplerates;
324 case SR_CONF_TRIGGER_TYPE:
325 *data = (char *)TRIGGER_TYPE;
334 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
337 struct dev_context *devc;
338 uint32_t trigger_config[4];
340 uint16_t readcount, delaycount;
341 uint8_t changrp_mask;
347 if (sdi->status != SR_ST_ACTIVE)
350 if (ols_configure_probes(sdi) != SR_OK) {
351 sr_err("Failed to configure probes.");
356 * Enable/disable channel groups in the flag register according to the
357 * probe mask. Calculate this here, because num_channels is needed
358 * to limit readcount.
362 for (i = 0; i < 4; i++) {
363 if (devc->probe_mask & (0xff << (i * 8))) {
364 changrp_mask |= (1 << i);
370 * Limit readcount to prevent reading past the end of the hardware
373 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
375 memset(trigger_config, 0, 16);
376 trigger_config[devc->num_stages - 1] |= 0x08;
377 if (devc->trigger_mask[0]) {
378 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
379 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
381 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0,
382 reverse32(devc->trigger_mask[0])) != SR_OK)
384 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0,
385 reverse32(devc->trigger_value[0])) != SR_OK)
387 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0,
388 trigger_config[0]) != SR_OK)
391 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_1,
392 reverse32(devc->trigger_mask[1])) != SR_OK)
394 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_1,
395 reverse32(devc->trigger_value[1])) != SR_OK)
397 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_1,
398 trigger_config[1]) != SR_OK)
401 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_2,
402 reverse32(devc->trigger_mask[2])) != SR_OK)
404 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_2,
405 reverse32(devc->trigger_value[2])) != SR_OK)
407 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_2,
408 trigger_config[2]) != SR_OK)
411 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_3,
412 reverse32(devc->trigger_mask[3])) != SR_OK)
414 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_3,
415 reverse32(devc->trigger_value[3])) != SR_OK)
417 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_3,
418 trigger_config[3]) != SR_OK)
421 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0,
422 devc->trigger_mask[0]) != SR_OK)
424 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0,
425 devc->trigger_value[0]) != SR_OK)
427 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0,
428 0x00000008) != SR_OK)
430 delaycount = readcount;
433 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
434 "demux %s)", devc->cur_samplerate, devc->cur_samplerate_divider,
435 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
436 if (send_longcommand(devc->serial, CMD_SET_DIVIDER,
437 reverse32(devc->cur_samplerate_divider)) != SR_OK)
440 /* Send sample limit and pre/post-trigger capture ratio. */
441 data = ((readcount - 1) & 0xffff) << 16;
442 data |= (delaycount - 1) & 0xffff;
443 if (send_longcommand(devc->serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
446 /* The flag register wants them here, and 1 means "disable channel". */
447 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
448 devc->flag_reg |= FLAG_FILTER;
450 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
451 if (send_longcommand(devc->serial, CMD_SET_FLAGS, data) != SR_OK)
454 /* Start acquisition on the device. */
455 if (send_shortcommand(devc->serial, CMD_RUN) != SR_OK)
458 /* Send header packet to the session bus. */
459 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
461 sr_source_add(devc->serial->fd, G_IO_IN, -1, ols_receive_data,
467 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
468 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
470 /* Avoid compiler warnings. */
473 abort_acquisition(sdi);
478 SR_PRIV struct sr_dev_driver ols_driver_info = {
480 .longname = "Openbench Logic Sniffer",
483 .cleanup = hw_cleanup,
485 .dev_list = hw_dev_list,
486 .dev_clear = hw_cleanup,
487 .config_get = config_get,
488 .config_set = config_set,
489 .config_list = config_list,
490 .dev_open = hw_dev_open,
491 .dev_close = hw_dev_close,
492 .dev_acquisition_start = hw_dev_acquisition_start,
493 .dev_acquisition_stop = hw_dev_acquisition_stop,