2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 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/>.
23 #include <sys/types.h>
36 #include <arpa/inet.h>
40 #include <sigrok-internal.h>
43 #define O_NONBLOCK FIONBIO
47 #define NUM_TRIGGER_STAGES 4
48 #define TRIGGER_TYPES "01"
49 #define SERIAL_SPEED B115200
50 #define CLOCK_RATE MHZ(100)
51 #define MIN_NUM_SAMPLES 4
54 #define CMD_RESET 0x00
56 #define CMD_SET_FLAGS 0x82
57 #define CMD_SET_DIVIDER 0x80
59 #define CMD_CAPTURE_SIZE 0x81
60 #define CMD_SET_TRIGGER_MASK_0 0xc0
61 #define CMD_SET_TRIGGER_MASK_1 0xc4
62 #define CMD_SET_TRIGGER_MASK_2 0xc8
63 #define CMD_SET_TRIGGER_MASK_3 0xcc
64 #define CMD_SET_TRIGGER_VALUE_0 0xc1
65 #define CMD_SET_TRIGGER_VALUE_1 0xc5
66 #define CMD_SET_TRIGGER_VALUE_2 0xc9
67 #define CMD_SET_TRIGGER_VALUE_3 0xcd
68 #define CMD_SET_TRIGGER_CONFIG_0 0xc2
69 #define CMD_SET_TRIGGER_CONFIG_1 0xc6
70 #define CMD_SET_TRIGGER_CONFIG_2 0xca
71 #define CMD_SET_TRIGGER_CONFIG_3 0xce
73 /* Bitmasks for CMD_FLAGS */
74 #define FLAG_DEMUX 0x01
75 #define FLAG_FILTER 0x02
76 #define FLAG_CHANNELGROUP_1 0x04
77 #define FLAG_CHANNELGROUP_2 0x08
78 #define FLAG_CHANNELGROUP_3 0x10
79 #define FLAG_CHANNELGROUP_4 0x20
80 #define FLAG_CLOCK_EXTERNAL 0x40
81 #define FLAG_CLOCK_INVERTED 0x80
82 #define FLAG_RLE 0x0100
84 static int capabilities[] = {
92 static struct samplerates samplerates = {
99 /* List of struct serial_device_instance */
100 static GSList *device_instances = NULL;
102 /* Current state of the flag register */
103 static uint32_t flag_reg = 0;
105 static uint64_t cur_samplerate = 0;
106 static uint64_t limit_samples = 0;
108 * Pre/post trigger capture ratio, in percentage.
109 * 0 means no pre-trigger data.
111 static int capture_ratio = 0;
112 static int trigger_at = -1;
113 static uint32_t probe_mask = 0xffffffff;
114 static uint32_t trigger_mask[4] = { 0, 0, 0, 0 };
115 static uint32_t trigger_value[4] = { 0, 0, 0, 0 };
116 static int num_stages = 0;
118 static int send_shortcommand(int fd, uint8_t command)
122 g_debug("ols: sending cmd 0x%.2x", command);
124 if (serial_write(fd, buf, 1) != 1)
130 static int send_longcommand(int fd, uint8_t command, uint32_t data)
134 g_debug("ols: sending cmd 0x%.2x data 0x%.8x", command, data);
136 buf[1] = (data & 0xff000000) >> 24;
137 buf[2] = (data & 0xff0000) >> 16;
138 buf[3] = (data & 0xff00) >> 8;
139 buf[4] = data & 0xff;
140 if (serial_write(fd, buf, 5) != 5)
146 static int configure_probes(GSList *probes)
150 int probe_bit, stage, i;
154 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
156 trigger_value[i] = 0;
160 for (l = probes; l; l = l->next) {
161 probe = (struct probe *)l->data;
166 * Set up the probe mask for later configuration into the
169 probe_bit = 1 << (probe->index - 1);
170 probe_mask |= probe_bit;
175 /* Configure trigger mask and value. */
177 for (tc = probe->trigger; tc && *tc; tc++) {
178 trigger_mask[stage] |= probe_bit;
180 trigger_value[stage] |= probe_bit;
184 * TODO: Only supporting parallel mode, with
189 if (stage > num_stages)
196 static uint32_t reverse16(uint32_t in)
200 out = (in & 0xff) << 8;
201 out |= (in & 0xff00) >> 8;
202 out |= (in & 0xff0000) << 8;
203 out |= (in & 0xff000000) >> 8;
208 static uint32_t reverse32(uint32_t in)
212 out = (in & 0xff) << 24;
213 out |= (in & 0xff00) << 8;
214 out |= (in & 0xff0000) >> 8;
215 out |= (in & 0xff000000) >> 24;
220 static int hw_init(char *deviceinfo)
222 struct sigrok_device_instance *sdi;
225 int devcnt, final_devcnt, num_ports, fd, ret, i;
226 char buf[8], **device_names, **serial_params;
229 ports = g_slist_append(NULL, strdup(deviceinfo));
231 /* No specific device given, so scan all serial ports. */
232 ports = list_serial_ports();
234 num_ports = g_slist_length(ports);
235 fds = calloc(1, num_ports * sizeof(GPollFD));
236 device_names = malloc(num_ports * sizeof(char *));
237 serial_params = malloc(num_ports * sizeof(char *));
239 for (l = ports; l; l = l->next) {
240 /* The discovery procedure is like this: first send the Reset
241 * command (0x00) 5 times, since the device could be anywhere
242 * in a 5-byte command. Then send the ID command (0x02).
243 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
246 * Since it may take the device a while to respond at 115Kb/s,
247 * we do all the sending first, then wait for all of them to
248 * respond with g_poll().
250 g_message("ols: probing %s...", (char *)l->data);
251 fd = serial_open(l->data, O_RDWR | O_NONBLOCK);
253 serial_params[devcnt] = serial_backup_params(fd);
254 serial_set_params(fd, 115200, 8, 0, 1, 2);
256 for (i = 0; i < 5; i++) {
257 if ((ret = send_shortcommand(fd,
258 CMD_RESET)) != SIGROK_OK) {
259 /* Serial port is not writable. */
263 if (ret != SIGROK_OK) {
264 serial_restore_params(fd,
265 serial_params[devcnt]);
269 send_shortcommand(fd, CMD_ID);
271 fds[devcnt].events = G_IO_IN;
272 device_names[devcnt] = strdup(l->data);
278 /* 2ms isn't enough for reliable transfer with pl2303, let's try 10 */
282 g_poll(fds, devcnt, 1);
283 for (i = 0; i < devcnt; i++) {
284 if (fds[i].revents == G_IO_IN) {
285 if (serial_read(fds[i].fd, buf, 4) == 4) {
286 if (!strncmp(buf, "1SLO", 4)
287 || !strncmp(buf, "1ALS", 4)) {
288 if (!strncmp(buf, "1SLO", 4))
289 sdi = sigrok_device_instance_new
290 (final_devcnt, ST_INACTIVE,
292 "Logic Sniffer", "v1.0");
294 sdi = sigrok_device_instance_new
295 (final_devcnt, ST_INACTIVE,
296 "Openbench", "Logic Sniffer",
298 sdi->serial = serial_device_instance_new
299 (device_names[i], -1);
301 g_slist_append(device_instances, sdi);
303 serial_close(fds[i].fd);
307 free(device_names[i]);
310 if (fds[i].fd != 0) {
311 serial_restore_params(fds[i].fd, serial_params[i]);
312 serial_close(fds[i].fd);
314 free(serial_params[i]);
322 cur_samplerate = samplerates.low;
327 static int hw_opendev(int device_index)
329 struct sigrok_device_instance *sdi;
331 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
334 sdi->serial->fd = serial_open(sdi->serial->port, O_RDWR);
335 if (sdi->serial->fd == -1)
338 sdi->status = ST_ACTIVE;
343 static void hw_closedev(int device_index)
345 struct sigrok_device_instance *sdi;
347 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
350 if (sdi->serial->fd != -1) {
351 serial_close(sdi->serial->fd);
352 sdi->serial->fd = -1;
353 sdi->status = ST_INACTIVE;
357 static void hw_cleanup(void)
360 struct sigrok_device_instance *sdi;
362 /* Properly close all devices. */
363 for (l = device_instances; l; l = l->next) {
365 if (sdi->serial->fd != -1)
366 serial_close(sdi->serial->fd);
367 sigrok_device_instance_free(sdi);
369 g_slist_free(device_instances);
370 device_instances = NULL;
373 static void *hw_get_device_info(int device_index, int device_info_id)
375 struct sigrok_device_instance *sdi;
378 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
382 switch (device_info_id) {
387 info = GINT_TO_POINTER(NUM_PROBES);
392 case DI_TRIGGER_TYPES:
393 info = (char *)TRIGGER_TYPES;
395 case DI_CUR_SAMPLERATE:
396 info = &cur_samplerate;
403 static int hw_get_status(int device_index)
405 struct sigrok_device_instance *sdi;
407 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
413 static int *hw_get_capabilities(void)
418 static int set_configuration_samplerate(struct sigrok_device_instance *sdi,
423 if (samplerate < samplerates.low || samplerate > samplerates.high)
424 return SIGROK_ERR_SAMPLERATE;
426 if (samplerate > CLOCK_RATE) {
427 flag_reg |= FLAG_DEMUX;
428 divider = (CLOCK_RATE * 2 / samplerate) - 1;
430 flag_reg &= ~FLAG_DEMUX;
431 divider = (CLOCK_RATE / samplerate) - 1;
434 g_message("ols: setting samplerate to %" PRIu64 " Hz (divider %u, demux %s)",
435 samplerate, divider, flag_reg & FLAG_DEMUX ? "on" : "off");
437 if (send_longcommand(sdi->serial->fd, CMD_SET_DIVIDER, reverse32(divider)) != SIGROK_OK)
439 cur_samplerate = samplerate;
444 static int hw_set_configuration(int device_index, int capability, void *value)
446 struct sigrok_device_instance *sdi;
450 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
453 if (sdi->status != ST_ACTIVE)
456 switch (capability) {
457 case HWCAP_SAMPLERATE:
459 ret = set_configuration_samplerate(sdi, *tmp_u64);
461 case HWCAP_PROBECONFIG:
462 ret = configure_probes((GSList *) value);
464 case HWCAP_LIMIT_SAMPLES:
466 if (*tmp_u64 < MIN_NUM_SAMPLES)
468 limit_samples = *tmp_u64;
469 g_message("ols: sample limit %" PRIu64, limit_samples);
472 case HWCAP_CAPTURE_RATIO:
474 capture_ratio = *tmp_u64;
475 if (capture_ratio < 0 || capture_ratio > 100) {
488 static int receive_data(int fd, int revents, void *user_data)
490 static unsigned int num_transfers = 0;
491 static int num_bytes = 0;
492 static char last_sample[4] = { 0xff, 0xff, 0xff, 0xff };
493 static unsigned char sample[4] = { 0, 0, 0, 0 };
494 static unsigned char tmp_sample[4];
495 static unsigned char *raw_sample_buf = NULL;
496 int count, buflen, num_channels, offset, i, j;
497 struct datafeed_packet packet;
498 unsigned char byte, *buffer;
500 if (num_transfers++ == 0) {
502 * First time round, means the device started sending data,
503 * and will not stop until done. If it stops sending for
504 * longer than it takes to send a byte, that means it's
505 * finished. We'll double that to 30ms to be sure...
508 source_add(fd, G_IO_IN, 30, receive_data, user_data);
509 raw_sample_buf = malloc(limit_samples * 4);
510 /* fill with 1010... for debugging */
511 memset(raw_sample_buf, 0x82, limit_samples * 4);
515 for (i = 0x20; i > 0x02; i /= 2) {
516 if ((flag_reg & i) == 0)
520 if (revents == G_IO_IN
521 && num_transfers / num_channels <= limit_samples) {
522 if (serial_read(fd, &byte, 1) != 1)
525 sample[num_bytes++] = byte;
526 g_debug("ols: received byte 0x%.2x", byte);
527 if (num_bytes == num_channels) {
528 g_debug("ols: received sample 0x%.*x", num_bytes * 2, (int) *sample);
529 /* Got a full sample. */
530 if (flag_reg & FLAG_RLE) {
532 * In RLE mode -1 should never come in as a
533 * sample, because bit 31 is the "count" flag.
534 * TODO: Endianness may be wrong here, could be
538 && !(last_sample[0] & 0x80)) {
539 count = (int)(*sample) & 0x7fffffff;
540 buffer = g_malloc(count);
542 for (i = 0; i < count; i++) {
543 memcpy(buffer + buflen, last_sample, 4);
548 * Just a single sample, next sample
549 * will probably be a count referring
550 * to this -- but this one is still a
551 * part of the stream.
557 /* No compression. */
562 if (num_channels < 4) {
564 * Some channel groups may have been turned
565 * off, to speed up transfer between the
566 * hardware and the PC. Expand that here before
567 * submitting it over the session bus --
568 * whatever is listening on the bus will be
569 * expecting a full 32-bit sample, based on
570 * the number of probes.
573 memset(tmp_sample, 0, 4);
574 for (i = 0; i < 4; i++) {
575 if (((flag_reg >> 2) & (1 << i)) == 0) {
577 * This channel group was
578 * enabled, copy from received
581 tmp_sample[i] = sample[j++];
584 memcpy(sample, tmp_sample, 4);
585 g_debug("ols: full sample 0x%.8x", (int) *sample);
588 /* the OLS sends its sample buffer backwards.
589 * store it in reverse order here, so we can dump
590 * this on the session bus later.
592 offset = (limit_samples - num_transfers / num_channels) * 4;
593 memcpy(raw_sample_buf + offset, sample, 4);
595 if (buffer == sample)
596 memcpy(last_sample, buffer, num_channels);
600 memset(sample, 0, 4);
605 * This is the main loop telling us a timeout was reached, or
606 * we've acquired all the samples we asked for -- we're done.
607 * Send the (properly-ordered) buffer to the frontend.
609 if (trigger_at != -1) {
610 /* a trigger was set up, so we need to tell the frontend
613 if (trigger_at > 0) {
614 /* there are pre-trigger samples, send those first */
615 packet.type = DF_LOGIC;
616 packet.length = trigger_at * 4;
618 packet.payload = raw_sample_buf;
619 session_bus(user_data, &packet);
622 packet.type = DF_TRIGGER;
624 session_bus(user_data, &packet);
626 packet.type = DF_LOGIC;
627 packet.length = (limit_samples * 4) - (trigger_at * 4);
629 packet.payload = raw_sample_buf + trigger_at * 4;
630 session_bus(user_data, &packet);
632 packet.type = DF_LOGIC;
633 packet.length = limit_samples * 4;
635 packet.payload = raw_sample_buf;
636 session_bus(user_data, &packet);
638 free(raw_sample_buf);
642 packet.type = DF_END;
644 session_bus(user_data, &packet);
650 static int hw_start_acquisition(int device_index, gpointer session_device_id)
653 struct datafeed_packet *packet;
654 struct datafeed_header *header;
655 struct sigrok_device_instance *sdi;
656 uint32_t trigger_config[4];
658 uint16_t readcount, delaycount;
659 uint8_t changrp_mask;
661 if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
664 if (sdi->status != ST_ACTIVE)
667 readcount = limit_samples / 4;
669 memset(trigger_config, 0, 16);
670 trigger_config[num_stages-1] |= 0x08;
671 if (trigger_mask[0]) {
672 delaycount = readcount * (1 - capture_ratio / 100.0);
673 trigger_at = (readcount - delaycount) * 4 - num_stages;
675 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_0,
676 reverse32(trigger_mask[0])) != SIGROK_OK)
678 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_0,
679 reverse32(trigger_value[0])) != SIGROK_OK)
681 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
682 trigger_config[0]) != SIGROK_OK)
685 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_1,
686 reverse32(trigger_mask[1])) != SIGROK_OK)
688 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_1,
689 reverse32(trigger_value[1])) != SIGROK_OK)
691 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_1,
692 trigger_config[1]) != SIGROK_OK)
695 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_2,
696 reverse32(trigger_mask[2])) != SIGROK_OK)
698 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_2,
699 reverse32(trigger_value[2])) != SIGROK_OK)
701 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_2,
702 trigger_config[2]) != SIGROK_OK)
705 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_3,
706 reverse32(trigger_mask[3])) != SIGROK_OK)
708 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_3,
709 reverse32(trigger_value[3])) != SIGROK_OK)
711 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_3,
712 trigger_config[3]) != SIGROK_OK)
715 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_0,
716 trigger_mask[0]) != SIGROK_OK)
718 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_0,
719 trigger_value[0]) != SIGROK_OK)
721 if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_0,
722 0x00000008) != SIGROK_OK)
724 delaycount = readcount;
727 set_configuration_samplerate(sdi, cur_samplerate);
729 /* Send sample limit and pre/post-trigger capture ratio. */
730 data = ((readcount - 1) & 0xffff) << 16;
731 data |= (delaycount - 1) & 0xffff;
732 if (send_longcommand(sdi->serial->fd, CMD_CAPTURE_SIZE, reverse16(data)) != SIGROK_OK)
736 * Enable/disable channel groups in the flag register according to the
740 for (i = 0; i < 4; i++) {
741 if (probe_mask & (0xff << (i * 8)))
742 changrp_mask |= (1 << i);
745 /* The flag register wants them here, and 1 means "disable channel". */
746 flag_reg |= ~(changrp_mask << 2) & 0x3c;
747 flag_reg |= FLAG_FILTER;
748 data = flag_reg << 24;
749 if (send_longcommand(sdi->serial->fd, CMD_SET_FLAGS, data) != SIGROK_OK)
752 /* Start acquisition on the device. */
753 if (send_shortcommand(sdi->serial->fd, CMD_RUN) != SIGROK_OK)
756 source_add(sdi->serial->fd, G_IO_IN, -1, receive_data,
759 /* Send header packet to the session bus. */
760 packet = g_malloc(sizeof(struct datafeed_packet));
761 header = g_malloc(sizeof(struct datafeed_header));
762 if (!packet || !header)
764 packet->type = DF_HEADER;
765 packet->length = sizeof(struct datafeed_header);
766 packet->payload = (unsigned char *)header;
767 header->feed_version = 1;
768 gettimeofday(&header->starttime, NULL);
769 header->samplerate = cur_samplerate;
770 header->protocol_id = PROTO_RAW;
771 header->num_logic_probes = NUM_PROBES;
772 header->num_analog_probes = 0;
773 session_bus(session_device_id, packet);
780 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
782 struct datafeed_packet packet;
784 /* Avoid compiler warnings. */
785 device_index = device_index;
787 packet.type = DF_END;
789 session_bus(session_device_id, &packet);
792 struct device_plugin ols_plugin_info = {
802 hw_set_configuration,
803 hw_start_acquisition,