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 hwcaps[] = {
25 SR_HWCAP_LOGIC_ANALYZER,
27 SR_HWCAP_CAPTURE_RATIO,
28 SR_HWCAP_LIMIT_SAMPLES,
33 /* Probes are numbered 0-31 (on the PCB silkscreen). */
34 SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
35 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
36 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
37 "24", "25", "26", "27", "28", "29", "30", "31",
41 /* default supported samplerates, can be overridden by device metadata */
42 static const struct sr_samplerates samplerates = {
49 SR_PRIV struct sr_dev_driver ols_driver_info;
50 static struct sr_dev_driver *di = &ols_driver_info;
52 static int hw_init(struct sr_context *sr_ctx)
54 struct drv_context *drvc;
56 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
57 sr_err("Driver context malloc failed.");
60 drvc->sr_ctx = sr_ctx;
66 static GSList *hw_scan(GSList *options)
69 struct sr_dev_inst *sdi;
70 struct drv_context *drvc;
71 struct dev_context *devc;
72 struct sr_probe *probe;
73 struct sr_serial_dev_inst *serial;
77 const char *conn, *serialcomm;
84 conn = serialcomm = NULL;
85 for (l = options; l; l = l->next) {
91 case SR_HWOPT_SERIALCOMM:
92 serialcomm = opt->value;
99 if (serialcomm == NULL)
100 serialcomm = SERIALCOMM;
102 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
105 /* The discovery procedure is like this: first send the Reset
106 * command (0x00) 5 times, since the device could be anywhere
107 * in a 5-byte command. Then send the ID command (0x02).
108 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
111 sr_info("Probing %s.", conn);
112 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
116 for (i = 0; i < 5; i++) {
117 if ((ret = send_shortcommand(serial, CMD_RESET)) != SR_OK) {
118 sr_err("Port %s is not writable.", conn);
123 serial_close(serial);
124 sr_err("Could not use port %s. Quitting.", conn);
127 send_shortcommand(serial, CMD_ID);
129 /* Wait 10ms for a response. */
132 probefd.fd = serial->fd;
133 probefd.events = G_IO_IN;
134 g_poll(&probefd, 1, 1);
136 if (probefd.revents != G_IO_IN)
138 if (serial_read(serial, buf, 4) != 4)
140 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
143 /* Definitely using the OLS protocol, check if it supports
144 * the metadata command.
146 send_shortcommand(serial, CMD_METADATA);
147 if (g_poll(&probefd, 1, 10) > 0) {
149 sdi = get_metadata(serial);
153 /* Not an OLS -- some other board that uses the sump protocol. */
154 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
155 "Sump", "Logic Analyzer", "v1.0");
157 devc = ols_dev_new();
158 for (i = 0; i < 32; i++) {
159 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
160 ols_probe_names[i])))
162 sdi->probes = g_slist_append(sdi->probes, probe);
166 devc->serial = serial;
167 drvc->instances = g_slist_append(drvc->instances, sdi);
168 devices = g_slist_append(devices, sdi);
170 serial_close(serial);
175 static GSList *hw_dev_list(void)
177 struct drv_context *drvc;
181 return drvc->instances;
184 static int hw_dev_open(struct sr_dev_inst *sdi)
186 struct dev_context *devc;
190 if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
193 sdi->status = SR_ST_ACTIVE;
198 static int hw_dev_close(struct sr_dev_inst *sdi)
200 struct dev_context *devc;
204 if (devc->serial && devc->serial->fd != -1) {
205 serial_close(devc->serial);
206 sdi->status = SR_ST_INACTIVE;
212 static int hw_cleanup(void)
215 struct sr_dev_inst *sdi;
216 struct drv_context *drvc;
217 struct dev_context *devc;
220 if (!(drvc = di->priv))
223 /* Properly close and free all devices. */
224 for (l = drvc->instances; l; l = l->next) {
225 if (!(sdi = l->data)) {
226 /* Log error, but continue cleaning up the rest. */
227 sr_err("%s: sdi was NULL, continuing", __func__);
231 if (!(devc = sdi->priv)) {
232 /* Log error, but continue cleaning up the rest. */
233 sr_err("%s: sdi->priv was NULL, continuing", __func__);
238 sr_serial_dev_inst_free(devc->serial);
239 sr_dev_inst_free(sdi);
241 g_slist_free(drvc->instances);
242 drvc->instances = NULL;
247 static int hw_info_get(int info_id, const void **data,
248 const struct sr_dev_inst *sdi)
250 struct dev_context *devc;
256 case SR_DI_NUM_PROBES:
257 *data = GINT_TO_POINTER(1);
259 case SR_DI_PROBE_NAMES:
260 *data = ols_probe_names;
262 case SR_DI_SAMPLERATES:
263 *data = &samplerates;
265 case SR_DI_TRIGGER_TYPES:
266 *data = (char *)TRIGGER_TYPES;
268 case SR_DI_CUR_SAMPLERATE:
271 *data = &devc->cur_samplerate;
282 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
285 struct dev_context *devc;
287 const uint64_t *tmp_u64;
291 if (sdi->status != SR_ST_ACTIVE)
295 case SR_HWCAP_SAMPLERATE:
296 ret = ols_set_samplerate(sdi, *(const uint64_t *)value,
299 case SR_HWCAP_LIMIT_SAMPLES:
301 if (*tmp_u64 < MIN_NUM_SAMPLES)
303 if (*tmp_u64 > devc->max_samples)
304 sr_err("Sample limit exceeds hardware maximum.");
305 devc->limit_samples = *tmp_u64;
306 sr_info("Sample limit is %" PRIu64 ".", devc->limit_samples);
309 case SR_HWCAP_CAPTURE_RATIO:
310 devc->capture_ratio = *(const uint64_t *)value;
311 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
312 devc->capture_ratio = 0;
318 if (GPOINTER_TO_INT(value)) {
319 sr_info("Enabling RLE.");
320 devc->flag_reg |= FLAG_RLE;
331 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
334 struct sr_datafeed_packet *packet;
335 struct sr_datafeed_header *header;
336 struct sr_datafeed_meta_logic meta;
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 sr_source_add(devc->serial->fd, G_IO_IN, -1, ols_receive_data,
461 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
462 sr_err("Datafeed packet malloc failed.");
463 return SR_ERR_MALLOC;
466 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
467 sr_err("Datafeed header malloc failed.");
469 return SR_ERR_MALLOC;
472 /* Send header packet to the session bus. */
473 packet->type = SR_DF_HEADER;
474 packet->payload = (unsigned char *)header;
475 header->feed_version = 1;
476 gettimeofday(&header->starttime, NULL);
477 sr_session_send(cb_data, packet);
479 /* Send metadata about the SR_DF_LOGIC packets to come. */
480 packet->type = SR_DF_META_LOGIC;
481 packet->payload = &meta;
482 meta.samplerate = devc->cur_samplerate;
483 meta.num_probes = NUM_PROBES;
484 sr_session_send(cb_data, packet);
492 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
493 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
495 /* Avoid compiler warnings. */
498 abort_acquisition(sdi);
503 SR_PRIV struct sr_dev_driver ols_driver_info = {
505 .longname = "Openbench Logic Sniffer",
508 .cleanup = hw_cleanup,
510 .dev_list = hw_dev_list,
511 .dev_clear = hw_cleanup,
512 .dev_open = hw_dev_open,
513 .dev_close = hw_dev_close,
514 .info_get = hw_info_get,
515 .dev_config_set = hw_dev_config_set,
516 .dev_acquisition_start = hw_dev_acquisition_start,
517 .dev_acquisition_stop = hw_dev_acquisition_stop,