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_HWCAP_LOGIC_ANALYZER,
33 SR_HWCAP_CAPTURE_RATIO,
34 SR_HWCAP_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 struct drv_context *drvc;
62 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
63 sr_err("Driver context malloc failed.");
66 drvc->sr_ctx = sr_ctx;
72 static GSList *hw_scan(GSList *options)
75 struct sr_dev_inst *sdi;
76 struct drv_context *drvc;
77 struct dev_context *devc;
78 struct sr_probe *probe;
79 struct sr_serial_dev_inst *serial;
83 const char *conn, *serialcomm;
90 conn = serialcomm = NULL;
91 for (l = options; l; l = l->next) {
97 case SR_HWOPT_SERIALCOMM:
98 serialcomm = opt->value;
105 if (serialcomm == NULL)
106 serialcomm = SERIALCOMM;
108 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
111 /* The discovery procedure is like this: first send the Reset
112 * command (0x00) 5 times, since the device could be anywhere
113 * in a 5-byte command. Then send the ID command (0x02).
114 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
117 sr_info("Probing %s.", conn);
118 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
122 for (i = 0; i < 5; i++) {
123 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
124 sr_err("Port %s is not writable.", conn);
129 serial_close(serial);
130 sr_err("Could not use port %s. Quitting.", conn);
133 send_shortcommand(serial, CMD_ID);
135 /* Wait 10ms for a response. */
138 probefd.fd = serial->fd;
139 probefd.events = G_IO_IN;
140 g_poll(&probefd, 1, 1);
142 if (probefd.revents != G_IO_IN)
144 if (serial_read(serial, buf, 4) != 4)
146 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
149 /* Definitely using the OLS protocol, check if it supports
150 * the metadata command.
152 send_shortcommand(serial, CMD_METADATA);
153 if (g_poll(&probefd, 1, 10) > 0) {
155 sdi = get_metadata(serial);
159 /* Not an OLS -- some other board that uses the sump protocol. */
160 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
161 "Sump", "Logic Analyzer", "v1.0");
163 devc = ols_dev_new();
164 for (i = 0; i < 32; i++) {
165 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
166 ols_probe_names[i])))
168 sdi->probes = g_slist_append(sdi->probes, probe);
172 devc->serial = serial;
173 drvc->instances = g_slist_append(drvc->instances, sdi);
174 devices = g_slist_append(devices, sdi);
176 serial_close(serial);
181 static GSList *hw_dev_list(void)
183 struct drv_context *drvc;
187 return drvc->instances;
190 static int hw_dev_open(struct sr_dev_inst *sdi)
192 struct dev_context *devc;
196 if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
199 sdi->status = SR_ST_ACTIVE;
204 static int hw_dev_close(struct sr_dev_inst *sdi)
206 struct dev_context *devc;
210 if (devc->serial && devc->serial->fd != -1) {
211 serial_close(devc->serial);
212 sdi->status = SR_ST_INACTIVE;
218 static int hw_cleanup(void)
221 struct sr_dev_inst *sdi;
222 struct drv_context *drvc;
223 struct dev_context *devc;
226 if (!(drvc = di->priv))
229 /* Properly close and free all devices. */
230 for (l = drvc->instances; l; l = l->next) {
231 if (!(sdi = l->data)) {
232 /* Log error, but continue cleaning up the rest. */
233 sr_err("%s: sdi was NULL, continuing", __func__);
237 if (!(devc = sdi->priv)) {
238 /* Log error, but continue cleaning up the rest. */
239 sr_err("%s: sdi->priv was NULL, continuing", __func__);
244 sr_serial_dev_inst_free(devc->serial);
245 sr_dev_inst_free(sdi);
247 g_slist_free(drvc->instances);
248 drvc->instances = NULL;
253 static int hw_info_get(int info_id, const void **data,
254 const struct sr_dev_inst *sdi)
256 struct dev_context *devc;
265 case SR_DI_NUM_PROBES:
266 *data = GINT_TO_POINTER(1);
268 case SR_DI_PROBE_NAMES:
269 *data = ols_probe_names;
271 case SR_DI_SAMPLERATES:
272 *data = &samplerates;
274 case SR_DI_TRIGGER_TYPES:
275 *data = (char *)TRIGGER_TYPES;
277 case SR_DI_CUR_SAMPLERATE:
280 *data = &devc->cur_samplerate;
291 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
294 struct dev_context *devc;
296 const uint64_t *tmp_u64;
300 if (sdi->status != SR_ST_ACTIVE)
304 case SR_HWCAP_SAMPLERATE:
305 ret = ols_set_samplerate(sdi, *(const uint64_t *)value,
308 case SR_HWCAP_LIMIT_SAMPLES:
310 if (*tmp_u64 < MIN_NUM_SAMPLES)
312 if (*tmp_u64 > devc->max_samples)
313 sr_err("Sample limit exceeds hardware maximum.");
314 devc->limit_samples = *tmp_u64;
315 sr_info("Sample limit is %" PRIu64 ".", devc->limit_samples);
318 case SR_HWCAP_CAPTURE_RATIO:
319 devc->capture_ratio = *(const uint64_t *)value;
320 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
321 devc->capture_ratio = 0;
327 if (GPOINTER_TO_INT(value)) {
328 sr_info("Enabling RLE.");
329 devc->flag_reg |= FLAG_RLE;
340 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
343 struct sr_datafeed_packet *packet;
344 struct sr_datafeed_header *header;
345 struct sr_datafeed_meta_logic meta;
346 struct dev_context *devc;
347 uint32_t trigger_config[4];
349 uint16_t readcount, delaycount;
350 uint8_t changrp_mask;
356 if (sdi->status != SR_ST_ACTIVE)
359 if (ols_configure_probes(sdi) != SR_OK) {
360 sr_err("Failed to configure probes.");
365 * Enable/disable channel groups in the flag register according to the
366 * probe mask. Calculate this here, because num_channels is needed
367 * to limit readcount.
371 for (i = 0; i < 4; i++) {
372 if (devc->probe_mask & (0xff << (i * 8))) {
373 changrp_mask |= (1 << i);
379 * Limit readcount to prevent reading past the end of the hardware
382 readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
384 memset(trigger_config, 0, 16);
385 trigger_config[devc->num_stages - 1] |= 0x08;
386 if (devc->trigger_mask[0]) {
387 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
388 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
390 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0,
391 reverse32(devc->trigger_mask[0])) != SR_OK)
393 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0,
394 reverse32(devc->trigger_value[0])) != SR_OK)
396 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0,
397 trigger_config[0]) != SR_OK)
400 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_1,
401 reverse32(devc->trigger_mask[1])) != SR_OK)
403 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_1,
404 reverse32(devc->trigger_value[1])) != SR_OK)
406 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_1,
407 trigger_config[1]) != SR_OK)
410 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_2,
411 reverse32(devc->trigger_mask[2])) != SR_OK)
413 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_2,
414 reverse32(devc->trigger_value[2])) != SR_OK)
416 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_2,
417 trigger_config[2]) != SR_OK)
420 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_3,
421 reverse32(devc->trigger_mask[3])) != SR_OK)
423 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_3,
424 reverse32(devc->trigger_value[3])) != SR_OK)
426 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_3,
427 trigger_config[3]) != SR_OK)
430 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0,
431 devc->trigger_mask[0]) != SR_OK)
433 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0,
434 devc->trigger_value[0]) != SR_OK)
436 if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0,
437 0x00000008) != SR_OK)
439 delaycount = readcount;
442 sr_info("Setting samplerate to %" PRIu64 "Hz (divider %u, "
443 "demux %s)", devc->cur_samplerate, devc->cur_samplerate_divider,
444 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
445 if (send_longcommand(devc->serial, CMD_SET_DIVIDER,
446 reverse32(devc->cur_samplerate_divider)) != SR_OK)
449 /* Send sample limit and pre/post-trigger capture ratio. */
450 data = ((readcount - 1) & 0xffff) << 16;
451 data |= (delaycount - 1) & 0xffff;
452 if (send_longcommand(devc->serial, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK)
455 /* The flag register wants them here, and 1 means "disable channel". */
456 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
457 devc->flag_reg |= FLAG_FILTER;
459 data = (devc->flag_reg << 24) | ((devc->flag_reg << 8) & 0xff0000);
460 if (send_longcommand(devc->serial, CMD_SET_FLAGS, data) != SR_OK)
463 /* Start acquisition on the device. */
464 if (send_shortcommand(devc->serial, CMD_RUN) != SR_OK)
467 sr_source_add(devc->serial->fd, G_IO_IN, -1, ols_receive_data,
470 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
471 sr_err("Datafeed packet malloc failed.");
472 return SR_ERR_MALLOC;
475 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
476 sr_err("Datafeed header malloc failed.");
478 return SR_ERR_MALLOC;
481 /* Send header packet to the session bus. */
482 packet->type = SR_DF_HEADER;
483 packet->payload = (unsigned char *)header;
484 header->feed_version = 1;
485 gettimeofday(&header->starttime, NULL);
486 sr_session_send(cb_data, packet);
488 /* Send metadata about the SR_DF_LOGIC packets to come. */
489 packet->type = SR_DF_META_LOGIC;
490 packet->payload = &meta;
491 meta.samplerate = devc->cur_samplerate;
492 meta.num_probes = NUM_PROBES;
493 sr_session_send(cb_data, packet);
501 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
502 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
504 /* Avoid compiler warnings. */
507 abort_acquisition(sdi);
512 SR_PRIV struct sr_dev_driver ols_driver_info = {
514 .longname = "Openbench Logic Sniffer",
517 .cleanup = hw_cleanup,
519 .dev_list = hw_dev_list,
520 .dev_clear = hw_cleanup,
521 .dev_open = hw_dev_open,
522 .dev_close = hw_dev_close,
523 .info_get = hw_info_get,
524 .dev_config_set = hw_dev_config_set,
525 .dev_acquisition_start = hw_dev_acquisition_start,
526 .dev_acquisition_stop = hw_dev_acquisition_stop,