/* * This file is part of the sigrok project. * * Copyright (C) 2010-2012 Bert Vermeulen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include "protocol.h" #define SERIALCOMM "115200/8n1" static const int hwopts[] = { SR_CONF_CONN, SR_CONF_SERIALCOMM, 0, }; static const int hwcaps[] = { SR_CONF_LOGIC_ANALYZER, SR_CONF_SAMPLERATE, SR_CONF_CAPTURE_RATIO, SR_CONF_LIMIT_SAMPLES, SR_CONF_RLE, 0, }; /* Probes are numbered 0-31 (on the PCB silkscreen). */ SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", NULL, }; /* Default supported samplerates, can be overridden by device metadata. */ static const struct sr_samplerates samplerates = { .low = SR_HZ(10), .high = SR_MHZ(200), .step = SR_HZ(1), .list = NULL, }; SR_PRIV struct sr_dev_driver ols_driver_info; static struct sr_dev_driver *di = &ols_driver_info; static int hw_init(struct sr_context *sr_ctx) { return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN); } static GSList *hw_scan(GSList *options) { struct sr_config *src; struct sr_dev_inst *sdi; struct drv_context *drvc; struct dev_context *devc; struct sr_probe *probe; struct sr_serial_dev_inst *serial; GPollFD probefd; GSList *l, *devices; int ret, i; const char *conn, *serialcomm; char buf[8]; (void)options; drvc = di->priv; devices = NULL; conn = serialcomm = NULL; for (l = options; l; l = l->next) { src = l->data; switch (src->key) { case SR_CONF_CONN: conn = src->value; break; case SR_CONF_SERIALCOMM: serialcomm = src->value; break; } } if (!conn) return NULL; if (serialcomm == NULL) serialcomm = SERIALCOMM; if (!(serial = sr_serial_dev_inst_new(conn, serialcomm))) return NULL; /* The discovery procedure is like this: first send the Reset * command (0x00) 5 times, since the device could be anywhere * in a 5-byte command. Then send the ID command (0x02). * If the device responds with 4 bytes ("OLS1" or "SLA1"), we * have a match. */ sr_info("Probing %s.", conn); if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK) return NULL; ret = SR_OK; for (i = 0; i < 5; i++) { if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) { sr_err("Port %s is not writable.", conn); break; } } if (ret != SR_OK) { serial_close(serial); sr_err("Could not use port %s. Quitting.", conn); return NULL; } send_shortcommand(serial, CMD_ID); /* Wait 10ms for a response. */ g_usleep(10000); probefd.fd = serial->fd; probefd.events = G_IO_IN; g_poll(&probefd, 1, 1); if (probefd.revents != G_IO_IN) return NULL; if (serial_read(serial, buf, 4) != 4) return NULL; if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) return NULL; /* Definitely using the OLS protocol, check if it supports * the metadata command. */ send_shortcommand(serial, CMD_METADATA); if (g_poll(&probefd, 1, 10) > 0) { /* Got metadata. */ sdi = get_metadata(serial); sdi->index = 0; devc = sdi->priv; } else { /* Not an OLS -- some other board that uses the sump protocol. */ sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Sump", "Logic Analyzer", "v1.0"); sdi->driver = di; devc = ols_dev_new(); for (i = 0; i < 32; i++) { if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, ols_probe_names[i]))) return 0; sdi->probes = g_slist_append(sdi->probes, probe); } sdi->priv = devc; } devc->serial = serial; drvc->instances = g_slist_append(drvc->instances, sdi); devices = g_slist_append(devices, sdi); serial_close(serial); return devices; } static GSList *hw_dev_list(void) { struct drv_context *drvc; drvc = di->priv; return drvc->instances; } static int hw_dev_open(struct sr_dev_inst *sdi) { struct dev_context *devc; devc = sdi->priv; if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK) return SR_ERR; sdi->status = SR_ST_ACTIVE; return SR_OK; } static int hw_dev_close(struct sr_dev_inst *sdi) { struct dev_context *devc; devc = sdi->priv; if (devc->serial && devc->serial->fd != -1) { serial_close(devc->serial); sdi->status = SR_ST_INACTIVE; } return SR_OK; } static int hw_cleanup(void) { GSList *l; struct sr_dev_inst *sdi; struct drv_context *drvc; struct dev_context *devc; int ret = SR_OK; if (!(drvc = di->priv)) return SR_OK; /* Properly close and free all devices. */ for (l = drvc->instances; l; l = l->next) { if (!(sdi = l->data)) { /* Log error, but continue cleaning up the rest. */ sr_err("%s: sdi was NULL, continuing", __func__); ret = SR_ERR_BUG; continue; } if (!(devc = sdi->priv)) { /* Log error, but continue cleaning up the rest. */ sr_err("%s: sdi->priv was NULL, continuing", __func__); ret = SR_ERR_BUG; continue; } hw_dev_close(sdi); sr_serial_dev_inst_free(devc->serial); sr_dev_inst_free(sdi); } g_slist_free(drvc->instances); drvc->instances = NULL; return ret; } static int config_get(int id, const void **data, const struct sr_dev_inst *sdi) { struct dev_context *devc; switch (id) { case SR_CONF_SAMPLERATE: if (sdi) { devc = sdi->priv; *data = &devc->cur_samplerate; } else return SR_ERR; break; default: return SR_ERR_ARG; } return SR_OK; } static int config_set(int id, const void *value, const struct sr_dev_inst *sdi) { struct dev_context *devc; int ret; const uint64_t *tmp_u64; devc = sdi->priv; if (sdi->status != SR_ST_ACTIVE) return SR_ERR; switch (id) { case SR_CONF_SAMPLERATE: ret = ols_set_samplerate(sdi, *(const uint64_t *)value, &samplerates); break; case SR_CONF_LIMIT_SAMPLES: tmp_u64 = value; if (*tmp_u64 < MIN_NUM_SAMPLES) return SR_ERR; if (*tmp_u64 > devc->max_samples) sr_err("Sample limit exceeds hardware maximum."); devc->limit_samples = *tmp_u64; sr_info("Sample limit is %" PRIu64 ".", devc->limit_samples); ret = SR_OK; break; case SR_CONF_CAPTURE_RATIO: devc->capture_ratio = *(const uint64_t *)value; if (devc->capture_ratio < 0 || devc->capture_ratio > 100) { devc->capture_ratio = 0; ret = SR_ERR; } else ret = SR_OK; break; case SR_CONF_RLE: if (GPOINTER_TO_INT(value)) { sr_info("Enabling RLE."); devc->flag_reg |= FLAG_RLE; } ret = SR_OK; break; default: ret = SR_ERR; } return ret; } static int config_list(int key, const void **data, const struct sr_dev_inst *sdi) { (void)sdi; switch (key) { case SR_CONF_SCAN_OPTIONS: *data = hwopts; break; case SR_CONF_DEVICE_OPTIONS: *data = hwcaps; break; case SR_CONF_SAMPLERATE: *data = &samplerates; break; case SR_CONF_TRIGGER_TYPE: *data = (char *)TRIGGER_TYPE; break; default: return SR_ERR_ARG; } return SR_OK; } static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data) { struct sr_datafeed_packet *packet; struct sr_datafeed_header *header; struct dev_context *devc; uint32_t trigger_config[4]; uint32_t data; uint16_t readcount, delaycount; uint8_t changrp_mask; int num_channels; int i; devc = sdi->priv; if (sdi->status != SR_ST_ACTIVE) return SR_ERR; if (ols_configure_probes(sdi) != SR_OK) { sr_err("Failed to configure probes."); return SR_ERR; } /* * Enable/disable channel groups in the flag register according to the * probe mask. Calculate this here, because num_channels is needed * to limit readcount. */ changrp_mask = 0; num_channels = 0; for (i = 0; i < 4; i++) { if (devc->probe_mask & (0xff << (i * 8))) { changrp_mask |= (1 << i); num_channels++; } } /* * Limit readcount to prevent reading past the end of the hardware * buffer. */ readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4; memset(trigger_config, 0, 16); trigger_config[devc->num_stages - 1] |= 0x08; if (devc->trigger_mask[0]) { delaycount = readcount * (1 - devc->capture_ratio / 100.0); devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0, reverse32(devc->trigger_mask[0])) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0, reverse32(devc->trigger_value[0])) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0, trigger_config[0]) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_1, reverse32(devc->trigger_mask[1])) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_1, reverse32(devc->trigger_value[1])) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_1, trigger_config[1]) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_2, reverse32(devc->trigger_mask[2])) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_2, reverse32(devc->trigger_value[2])) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_2, trigger_config[2]) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_3, reverse32(devc->trigger_mask[3])) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_3, reverse32(devc->trigger_value[3])) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_3, trigger_config[3]) != SR_OK) return SR_ERR; } else { if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0, devc->trigger_mask[0]) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0, devc->trigger_value[0]) != SR_OK) return SR_ERR; if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0, 0x00000008) != SR_OK) return SR_ERR; delaycount = readcount; } sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, " "demux %s)", devc->cur_samplerate, devc->cur_samplerate_divider, devc->flag_reg & FLAG_DEMUX ? "on" : "off"); if (send_longcommand(devc->serial, CMD_SET_DIVIDER, reverse32(devc->cur_samplerate_divider)) != SR_OK) return SR_ERR; /* Send sample limit and pre/post-trigger capture ratio. */ data = ((readcount - 1) & 0xffff) << 16; data |= (delaycount - 1) & 0xffff; if (send_longcommand(devc->serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK) return SR_ERR; /* The flag register wants them here, and 1 means "disable channel". */ devc->flag_reg |= ~(changrp_mask << 2) & 0x3c; devc->flag_reg |= FLAG_FILTER; devc->rle_count = 0; data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000); if (send_longcommand(devc->serial, CMD_SET_FLAGS, data) != SR_OK) return SR_ERR; /* Start acquisition on the device. */ if (send_shortcommand(devc->serial, CMD_RUN) != SR_OK) return SR_ERR; sr_source_add(devc->serial->fd, G_IO_IN, -1, ols_receive_data, cb_data); if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) { sr_err("Datafeed packet malloc failed."); return SR_ERR_MALLOC; } if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) { sr_err("Datafeed header malloc failed."); g_free(packet); return SR_ERR_MALLOC; } /* Send header packet to the session bus. */ packet->type = SR_DF_HEADER; packet->payload = (unsigned char *)header; header->feed_version = 1; gettimeofday(&header->starttime, NULL); sr_session_send(cb_data, packet); g_free(header); g_free(packet); return SR_OK; } /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */ static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) { /* Avoid compiler warnings. */ (void)cb_data; abort_acquisition(sdi); return SR_OK; } SR_PRIV struct sr_dev_driver ols_driver_info = { .name = "ols", .longname = "Openbench Logic Sniffer", .api_version = 1, .init = hw_init, .cleanup = hw_cleanup, .scan = hw_scan, .dev_list = hw_dev_list, .dev_clear = hw_cleanup, .config_get = config_get, .config_set = config_set, .config_list = config_list, .dev_open = hw_dev_open, .dev_close = hw_dev_close, .dev_acquisition_start = hw_dev_acquisition_start, .dev_acquisition_stop = hw_dev_acquisition_stop, .priv = NULL, };