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 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
152 "Sump", "Logic Analyzer", "v1.0");
154 devc = ols_dev_new();
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);
163 devc->serial = serial;
164 drvc->instances = g_slist_append(drvc->instances, sdi);
165 devices = g_slist_append(devices, sdi);
167 serial_close(serial);
172 static GSList *hw_dev_list(void)
174 return ((struct drv_context *)(di->priv))->instances;
177 static int hw_dev_open(struct sr_dev_inst *sdi)
179 struct dev_context *devc;
183 if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
186 sdi->status = SR_ST_ACTIVE;
191 static int hw_dev_close(struct sr_dev_inst *sdi)
193 struct dev_context *devc;
197 if (devc->serial && devc->serial->fd != -1) {
198 serial_close(devc->serial);
199 sdi->status = SR_ST_INACTIVE;
205 static int hw_cleanup(void)
208 struct sr_dev_inst *sdi;
209 struct drv_context *drvc;
210 struct dev_context *devc;
213 if (!(drvc = di->priv))
216 /* Properly close and free all devices. */
217 for (l = drvc->instances; l; l = l->next) {
218 if (!(sdi = l->data)) {
219 /* Log error, but continue cleaning up the rest. */
220 sr_err("%s: sdi was NULL, continuing", __func__);
224 if (!(devc = sdi->priv)) {
225 /* Log error, but continue cleaning up the rest. */
226 sr_err("%s: sdi->priv was NULL, continuing", __func__);
231 sr_serial_dev_inst_free(devc->serial);
232 sr_dev_inst_free(sdi);
234 g_slist_free(drvc->instances);
235 drvc->instances = NULL;
240 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
242 struct dev_context *devc;
249 case SR_CONF_SAMPLERATE:
250 *data = g_variant_new_uint64(devc->cur_samplerate);
252 case SR_CONF_CAPTURE_RATIO:
253 *data = g_variant_new_uint64(devc->capture_ratio);
255 case SR_CONF_LIMIT_SAMPLES:
256 *data = g_variant_new_uint64(devc->limit_samples);
259 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
268 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
270 struct dev_context *devc;
276 if (sdi->status != SR_ST_ACTIVE)
280 case SR_CONF_SAMPLERATE:
281 tmp_u64 = g_variant_get_uint64(data);
282 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
283 return SR_ERR_SAMPLERATE;
284 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
286 case SR_CONF_LIMIT_SAMPLES:
287 tmp_u64 = g_variant_get_uint64(data);
288 if (tmp_u64 < MIN_NUM_SAMPLES)
290 devc->limit_samples = tmp_u64;
293 case SR_CONF_CAPTURE_RATIO:
294 devc->capture_ratio = g_variant_get_uint64(data);
295 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
296 devc->capture_ratio = 0;
302 if (g_variant_get_boolean(data)) {
303 sr_info("Enabling RLE.");
304 devc->flag_reg |= FLAG_RLE;
306 sr_info("Disabling RLE.");
307 devc->flag_reg &= ~FLAG_RLE;
318 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
326 case SR_CONF_SCAN_OPTIONS:
327 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
328 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
330 case SR_CONF_DEVICE_OPTIONS:
331 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
332 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
334 case SR_CONF_SAMPLERATE:
335 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
336 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
337 ARRAY_SIZE(samplerates), sizeof(uint64_t));
338 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
339 *data = g_variant_builder_end(&gvb);
341 case SR_CONF_TRIGGER_TYPE:
342 *data = g_variant_new_string(TRIGGER_TYPE);
351 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
354 struct dev_context *devc;
355 uint32_t trigger_config[4];
357 uint16_t readcount, delaycount;
358 uint8_t changrp_mask;
364 if (sdi->status != SR_ST_ACTIVE)
367 if (ols_configure_probes(sdi) != SR_OK) {
368 sr_err("Failed to configure probes.");
373 * Enable/disable channel groups in the flag register according to the
374 * probe mask. Calculate this here, because num_channels is needed
375 * to limit readcount.
379 for (i = 0; i < 4; i++) {
380 if (devc->probe_mask & (0xff << (i * 8))) {
381 changrp_mask |= (1 << i);
387 * Limit readcount to prevent reading past the end of the hardware
390 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
392 memset(trigger_config, 0, 16);
393 trigger_config[devc->num_stages - 1] |= 0x08;
394 if (devc->trigger_mask[0]) {
395 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
396 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
398 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0,
399 reverse32(devc->trigger_mask[0])) != SR_OK)
401 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0,
402 reverse32(devc->trigger_value[0])) != SR_OK)
404 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0,
405 trigger_config[0]) != SR_OK)
408 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_1,
409 reverse32(devc->trigger_mask[1])) != SR_OK)
411 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_1,
412 reverse32(devc->trigger_value[1])) != SR_OK)
414 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_1,
415 trigger_config[1]) != SR_OK)
418 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_2,
419 reverse32(devc->trigger_mask[2])) != SR_OK)
421 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_2,
422 reverse32(devc->trigger_value[2])) != SR_OK)
424 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_2,
425 trigger_config[2]) != SR_OK)
428 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_3,
429 reverse32(devc->trigger_mask[3])) != SR_OK)
431 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_3,
432 reverse32(devc->trigger_value[3])) != SR_OK)
434 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_3,
435 trigger_config[3]) != SR_OK)
438 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0,
439 devc->trigger_mask[0]) != SR_OK)
441 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0,
442 devc->trigger_value[0]) != SR_OK)
444 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0,
445 0x00000008) != SR_OK)
447 delaycount = readcount;
450 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
451 "demux %s)", devc->cur_samplerate, devc->cur_samplerate_divider,
452 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
453 if (send_longcommand(devc->serial, CMD_SET_DIVIDER,
454 reverse32(devc->cur_samplerate_divider)) != SR_OK)
457 /* Send sample limit and pre/post-trigger capture ratio. */
458 data = ((readcount - 1) & 0xffff) << 16;
459 data |= (delaycount - 1) & 0xffff;
460 if (send_longcommand(devc->serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
463 /* The flag register wants them here, and 1 means "disable channel". */
464 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
465 devc->flag_reg |= FLAG_FILTER;
467 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
468 if (send_longcommand(devc->serial, CMD_SET_FLAGS, data) != SR_OK)
471 /* Start acquisition on the device. */
472 if (send_shortcommand(devc->serial, CMD_RUN) != SR_OK)
475 /* Send header packet to the session bus. */
476 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
478 sr_source_add(devc->serial->fd, G_IO_IN, -1, ols_receive_data,
484 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
485 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
487 /* Avoid compiler warnings. */
490 abort_acquisition(sdi);
495 SR_PRIV struct sr_dev_driver ols_driver_info = {
497 .longname = "Openbench Logic Sniffer",
500 .cleanup = hw_cleanup,
502 .dev_list = hw_dev_list,
503 .dev_clear = hw_cleanup,
504 .config_get = config_get,
505 .config_set = config_set,
506 .config_list = config_list,
507 .dev_open = hw_dev_open,
508 .dev_close = hw_dev_close,
509 .dev_acquisition_start = hw_dev_acquisition_start,
510 .dev_acquisition_stop = hw_dev_acquisition_stop,