X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fopenbench-logic-sniffer%2Fols.c;h=d71c025123cc6446a3b1918a3dd55404a7a03922;hb=c73d2ea421c2b425c3f0ae33bce2bfd0c448ca5f;hp=d5eb8ac918c27259d8e01f47f7b15b772c8c12bc;hpb=d32d961d17e3c7f409912062e5c336c19b6ef270;p=libsigrok.git diff --git a/hardware/openbench-logic-sniffer/ols.c b/hardware/openbench-logic-sniffer/ols.c index d5eb8ac9..d71c0251 100644 --- a/hardware/openbench-logic-sniffer/ols.c +++ b/hardware/openbench-logic-sniffer/ols.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2010 Bert Vermeulen + * 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 @@ -24,7 +24,9 @@ #include #include #include -#ifndef _WIN32 +#ifdef _WIN32 +#include +#else #include #endif #include @@ -36,90 +38,75 @@ #include #endif #include -#include -#include +#include "sigrok.h" +#include "sigrok-internal.h" +#include "ols.h" #ifdef _WIN32 #define O_NONBLOCK FIONBIO #endif -#define NUM_PROBES 32 -#define NUM_TRIGGER_STAGES 4 -#define TRIGGER_TYPES "01" -#define SERIAL_SPEED B115200 -#define CLOCK_RATE MHZ(100) -#define MIN_NUM_SAMPLES 4 - -/* Command opcodes */ -#define CMD_RESET 0x00 -#define CMD_ID 0x02 -#define CMD_SET_FLAGS 0x82 -#define CMD_SET_DIVIDER 0x80 -#define CMD_RUN 0x01 -#define CMD_CAPTURE_SIZE 0x81 -#define CMD_SET_TRIGGER_MASK_0 0xc0 -#define CMD_SET_TRIGGER_MASK_1 0xc4 -#define CMD_SET_TRIGGER_MASK_2 0xc8 -#define CMD_SET_TRIGGER_MASK_3 0xcc -#define CMD_SET_TRIGGER_VALUE_0 0xc1 -#define CMD_SET_TRIGGER_VALUE_1 0xc5 -#define CMD_SET_TRIGGER_VALUE_2 0xc9 -#define CMD_SET_TRIGGER_VALUE_3 0xcd -#define CMD_SET_TRIGGER_CONFIG_0 0xc2 -#define CMD_SET_TRIGGER_CONFIG_1 0xc6 -#define CMD_SET_TRIGGER_CONFIG_2 0xca -#define CMD_SET_TRIGGER_CONFIG_3 0xce - -/* Bitmasks for CMD_FLAGS */ -#define FLAG_DEMUX 0x01 -#define FLAG_FILTER 0x02 -#define FLAG_CHANNELGROUP_1 0x04 -#define FLAG_CHANNELGROUP_2 0x08 -#define FLAG_CHANNELGROUP_3 0x10 -#define FLAG_CHANNELGROUP_4 0x20 -#define FLAG_CLOCK_EXTERNAL 0x40 -#define FLAG_CLOCK_INVERTED 0x80 -#define FLAG_RLE 0x0100 - static int capabilities[] = { - HWCAP_LOGIC_ANALYZER, - HWCAP_SAMPLERATE, - HWCAP_CAPTURE_RATIO, - HWCAP_LIMIT_SAMPLES, + SR_HWCAP_LOGIC_ANALYZER, + SR_HWCAP_SAMPLERATE, + SR_HWCAP_CAPTURE_RATIO, + SR_HWCAP_LIMIT_SAMPLES, + SR_HWCAP_RLE, 0, }; -static struct samplerates samplerates = { - 10, - MHZ(200), - 1, - 0, +static const char *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, }; -/* List of struct serial_device_instance */ -static GSList *device_instances = NULL; - -/* Current state of the flag register */ -static uint32_t flag_reg = 0; +/* default supported samplerates, can be overridden by device metadata */ +static struct sr_samplerates samplerates = { + SR_HZ(10), + SR_MHZ(200), + SR_HZ(1), + NULL, +}; -static uint64_t cur_samplerate = 0; -static uint64_t limit_samples = 0; -/* - * Pre/post trigger capture ratio, in percentage. - * 0 means no pre-trigger data. - */ -static int capture_ratio = 0; -static int trigger_at = -1; -static uint32_t probe_mask = 0xffffffff; -static uint32_t trigger_mask[4] = { 0, 0, 0, 0 }; -static uint32_t trigger_value[4] = { 0, 0, 0, 0 }; -static int num_stages = 0; +/* List of struct sr_serial_device_instance */ +static GSList *device_instances = NULL; static int send_shortcommand(int fd, uint8_t command) { char buf[1]; - g_debug("ols: sending cmd 0x%.2x", command); + sr_dbg("ols: sending cmd 0x%.2x", command); buf[0] = command; if (serial_write(fd, buf, 1) != 1) return SR_ERR; @@ -131,7 +118,7 @@ static int send_longcommand(int fd, uint8_t command, uint32_t data) { char buf[5]; - g_debug("ols: sending cmd 0x%.2x data 0x%.8x", command, data); + sr_dbg("ols: sending cmd 0x%.2x data 0x%.8x", command, data); buf[0] = command; buf[1] = (data & 0xff000000) >> 24; buf[2] = (data & 0xff0000) >> 16; @@ -143,22 +130,22 @@ static int send_longcommand(int fd, uint8_t command, uint32_t data) return SR_OK; } -static int configure_probes(GSList *probes) +static int configure_probes(struct ols_device *ols, GSList *probes) { - struct probe *probe; + struct sr_probe *probe; GSList *l; int probe_bit, stage, i; char *tc; - probe_mask = 0; + ols->probe_mask = 0; for (i = 0; i < NUM_TRIGGER_STAGES; i++) { - trigger_mask[i] = 0; - trigger_value[i] = 0; + ols->trigger_mask[i] = 0; + ols->trigger_value[i] = 0; } - num_stages = 0; + ols->num_stages = 0; for (l = probes; l; l = l->next) { - probe = (struct probe *)l->data; + probe = (struct sr_probe *)l->data; if (!probe->enabled) continue; @@ -167,7 +154,7 @@ static int configure_probes(GSList *probes) * flag register. */ probe_bit = 1 << (probe->index - 1); - probe_mask |= probe_bit; + ols->probe_mask |= probe_bit; if (!probe->trigger) continue; @@ -175,9 +162,9 @@ static int configure_probes(GSList *probes) /* Configure trigger mask and value. */ stage = 0; for (tc = probe->trigger; tc && *tc; tc++) { - trigger_mask[stage] |= probe_bit; + ols->trigger_mask[stage] |= probe_bit; if (*tc == '1') - trigger_value[stage] |= probe_bit; + ols->trigger_value[stage] |= probe_bit; stage++; if (stage > 3) /* @@ -186,8 +173,8 @@ static int configure_probes(GSList *probes) */ return SR_ERR; } - if (stage > num_stages) - num_stages = stage; + if (stage > ols->num_stages) + ols->num_stages = stage; } return SR_OK; @@ -217,24 +204,183 @@ static uint32_t reverse32(uint32_t in) return out; } -static int hw_init(char *deviceinfo) +static struct ols_device *ols_device_new(void) +{ + struct ols_device *ols; + + /* TODO: Is 'ols' ever g_free()'d? */ + if (!(ols = g_try_malloc0(sizeof(struct ols_device)))) { + sr_err("ols: %s: ols malloc failed", __func__); + return NULL; + } + + ols->trigger_at = -1; + ols->probe_mask = 0xffffffff; + ols->cur_samplerate = SR_KHZ(200); + ols->serial = NULL; + + return ols; +} + +static struct sr_device_instance *get_metadata(int fd) +{ + struct sr_device_instance *sdi; + struct ols_device *ols; + uint32_t tmp_int; + uint8_t key, type, token; + GString *tmp_str, *devicename, *version; + gchar tmp_c; + + sdi = sr_device_instance_new(0, SR_ST_INACTIVE, NULL, NULL, NULL); + ols = ols_device_new(); + sdi->priv = ols; + + devicename = g_string_new(""); + version = g_string_new(""); + + key = 0xff; + while (key) { + if (serial_read(fd, &key, 1) != 1 || key == 0x00) + break; + type = key >> 5; + token = key & 0x1f; + switch (type) { + case 0: + /* NULL-terminated string */ + tmp_str = g_string_new(""); + while (serial_read(fd, &tmp_c, 1) == 1 && tmp_c != '\0') + g_string_append_c(tmp_str, tmp_c); + sr_dbg("ols: got metadata key 0x%.2x value '%s'", + key, tmp_str->str); + switch (token) { + case 0x01: + /* Device name */ + devicename = g_string_append(devicename, tmp_str->str); + break; + case 0x02: + /* FPGA firmware version */ + if (version->len) + g_string_append(version, ", "); + g_string_append(version, "FPGA version "); + g_string_append(version, tmp_str->str); + break; + case 0x03: + /* Ancillary version */ + if (version->len) + g_string_append(version, ", "); + g_string_append(version, "Ancillary version "); + g_string_append(version, tmp_str->str); + break; + default: + sr_info("ols: unknown token 0x%.2x: '%s'", + token, tmp_str->str); + break; + } + g_string_free(tmp_str, TRUE); + break; + case 1: + /* 32-bit unsigned integer */ + if (serial_read(fd, &tmp_int, 4) != 4) + break; + tmp_int = reverse32(tmp_int); + sr_dbg("ols: got metadata key 0x%.2x value 0x%.8x", + key, tmp_int); + switch (token) { + case 0x00: + /* Number of usable probes */ + ols->num_probes = tmp_int; + break; + case 0x01: + /* Amount of sample memory available (bytes) */ + ols->max_samples = tmp_int; + break; + case 0x02: + /* Amount of dynamic memory available (bytes) */ + /* what is this for? */ + break; + case 0x03: + /* Maximum sample rate (hz) */ + ols->max_samplerate = tmp_int; + break; + case 0x04: + /* protocol version */ + ols->protocol_version = tmp_int; + break; + default: + sr_info("ols: unknown token 0x%.2x: 0x%.8x", + token, tmp_int); + break; + } + break; + case 2: + /* 8-bit unsigned integer */ + if (serial_read(fd, &tmp_c, 1) != 1) + break; + sr_dbg("ols: got metadata key 0x%.2x value 0x%.2x", + key, tmp_c); + switch (token) { + case 0x00: + /* Number of usable probes */ + ols->num_probes = tmp_c; + break; + case 0x01: + /* protocol version */ + ols->protocol_version = tmp_c; + break; + default: + sr_info("ols: unknown token 0x%.2x: 0x%.2x", + token, tmp_c); + break; + } + break; + default: + /* unknown type */ + break; + } + } + + sdi->model = devicename->str; + sdi->version = version->str; + g_string_free(devicename, FALSE); + g_string_free(version, FALSE); + + return sdi; +} + +static int hw_init(const char *deviceinfo) { struct sr_device_instance *sdi; + struct ols_device *ols; GSList *ports, *l; - GPollFD *fds; + GPollFD *fds, probefd; int devcnt, final_devcnt, num_ports, fd, ret, i; char buf[8], **device_names, **serial_params; + final_devcnt = 0; + if (deviceinfo) - ports = g_slist_append(NULL, strdup(deviceinfo)); + ports = g_slist_append(NULL, g_strdup(deviceinfo)); else /* No specific device given, so scan all serial ports. */ ports = list_serial_ports(); num_ports = g_slist_length(ports); - fds = calloc(1, num_ports * sizeof(GPollFD)); - device_names = malloc(num_ports * sizeof(char *)); - serial_params = malloc(num_ports * sizeof(char *)); + + if (!(fds = g_try_malloc0(num_ports * sizeof(GPollFD)))) { + sr_err("ols: %s: fds malloc failed", __func__); + goto hw_init_free_ports; /* TODO: SR_ERR_MALLOC. */ + } + + if (!(device_names = g_try_malloc(num_ports * sizeof(char *)))) { + sr_err("ols: %s: device_names malloc failed", __func__); + goto hw_init_free_fds; /* TODO: SR_ERR_MALLOC. */ + } + + if (!(serial_params = g_try_malloc(num_ports * sizeof(char *)))) { + sr_err("ols: %s: serial_params malloc failed", __func__); + goto hw_init_free_device_names; /* TODO: SR_ERR_MALLOC. */ + } + devcnt = 0; for (l = ports; l; l = l->next) { /* The discovery procedure is like this: first send the Reset @@ -247,7 +393,7 @@ static int hw_init(char *deviceinfo) * we do all the sending first, then wait for all of them to * respond with g_poll(). */ - g_message("ols: probing %s...", (char *)l->data); + sr_info("ols: probing %s...", (char *)l->data); fd = serial_open(l->data, O_RDWR | O_NONBLOCK); if (fd != -1) { serial_params[devcnt] = serial_backup_params(fd); @@ -269,101 +415,125 @@ static int hw_init(char *deviceinfo) send_shortcommand(fd, CMD_ID); fds[devcnt].fd = fd; fds[devcnt].events = G_IO_IN; - device_names[devcnt] = strdup(l->data); + device_names[devcnt] = g_strdup(l->data); devcnt++; } - free(l->data); + g_free(l->data); } /* 2ms isn't enough for reliable transfer with pl2303, let's try 10 */ usleep(10000); - final_devcnt = 0; g_poll(fds, devcnt, 1); + for (i = 0; i < devcnt; i++) { - if (fds[i].revents == G_IO_IN) { - if (serial_read(fds[i].fd, buf, 4) == 4) { - if (!strncmp(buf, "1SLO", 4) - || !strncmp(buf, "1ALS", 4)) { - if (!strncmp(buf, "1SLO", 4)) - sdi = sr_device_instance_new - (final_devcnt, ST_INACTIVE, - "Openbench", - "Logic Sniffer", "v1.0"); - else - sdi = sr_device_instance_new - (final_devcnt, ST_INACTIVE, - "Openbench", "Logic Sniffer", - "v1.0"); - sdi->serial = serial_device_instance_new - (device_names[i], -1); - device_instances = - g_slist_append(device_instances, sdi); - final_devcnt++; - serial_close(fds[i].fd); - fds[i].fd = 0; - } - } - free(device_names[i]); + if (fds[i].revents != G_IO_IN) + continue; + if (serial_read(fds[i].fd, buf, 4) != 4) + continue; + if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) + continue; + + /* definitely using the OLS protocol, check if it supports + * the metadata command + */ + send_shortcommand(fds[i].fd, CMD_METADATA); + probefd.fd = fds[i].fd; + probefd.events = G_IO_IN; + if (g_poll(&probefd, 1, 10) > 0) { + /* got metadata */ + sdi = get_metadata(fds[i].fd); + sdi->index = final_devcnt; + } else { + /* not an OLS -- some other board that uses the sump protocol */ + sdi = sr_device_instance_new(final_devcnt, SR_ST_INACTIVE, + "Sump", "Logic Analyzer", "v1.0"); + ols = ols_device_new(); + ols->num_probes = 32; + sdi->priv = ols; } + ols->serial = sr_serial_device_instance_new(device_names[i], -1); + device_instances = g_slist_append(device_instances, sdi); + final_devcnt++; + serial_close(fds[i].fd); + fds[i].fd = 0; + } + /* clean up after all the probing */ + for (i = 0; i < devcnt; i++) { if (fds[i].fd != 0) { serial_restore_params(fds[i].fd, serial_params[i]); serial_close(fds[i].fd); } - free(serial_params[i]); + g_free(serial_params[i]); + g_free(device_names[i]); } - free(fds); - free(device_names); - free(serial_params); + g_free(serial_params); +hw_init_free_device_names: + g_free(device_names); +hw_init_free_fds: + g_free(fds); +hw_init_free_ports: g_slist_free(ports); - cur_samplerate = samplerates.low; - return final_devcnt; } static int hw_opendev(int device_index) { struct sr_device_instance *sdi; + struct ols_device *ols; if (!(sdi = sr_get_device_instance(device_instances, device_index))) return SR_ERR; - sdi->serial->fd = serial_open(sdi->serial->port, O_RDWR); - if (sdi->serial->fd == -1) + ols = sdi->priv; + + ols->serial->fd = serial_open(ols->serial->port, O_RDWR); + if (ols->serial->fd == -1) return SR_ERR; - sdi->status = ST_ACTIVE; + sdi->status = SR_ST_ACTIVE; return SR_OK; } -static void hw_closedev(int device_index) +static int hw_closedev(int device_index) { struct sr_device_instance *sdi; + struct ols_device *ols; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) - return; + if (!(sdi = sr_get_device_instance(device_instances, device_index))) { + sr_err("ols: %s: sdi was NULL", __func__); + return SR_ERR; /* TODO: SR_ERR_ARG? */ + } + + ols = sdi->priv; - if (sdi->serial->fd != -1) { - serial_close(sdi->serial->fd); - sdi->serial->fd = -1; - sdi->status = ST_INACTIVE; + /* TODO */ + if (ols->serial->fd != -1) { + serial_close(ols->serial->fd); + ols->serial->fd = -1; + sdi->status = SR_ST_INACTIVE; } + + return SR_OK; } static void hw_cleanup(void) { GSList *l; struct sr_device_instance *sdi; + struct ols_device *ols; - /* Properly close all devices. */ + /* Properly close and free all devices. */ for (l = device_instances; l; l = l->next) { sdi = l->data; - if (sdi->serial->fd != -1) - serial_close(sdi->serial->fd); + ols = sdi->priv; + if (ols->serial->fd != -1) + serial_close(ols->serial->fd); + sr_serial_device_instance_free(ols->serial); sr_device_instance_free(sdi); } g_slist_free(device_instances); @@ -373,27 +543,32 @@ static void hw_cleanup(void) static void *hw_get_device_info(int device_index, int device_info_id) { struct sr_device_instance *sdi; + struct ols_device *ols; void *info; if (!(sdi = sr_get_device_instance(device_instances, device_index))) return NULL; + ols = sdi->priv; info = NULL; switch (device_info_id) { - case DI_INSTANCE: + case SR_DI_INSTANCE: info = sdi; break; - case DI_NUM_PROBES: + case SR_DI_NUM_PROBES: info = GINT_TO_POINTER(NUM_PROBES); break; - case DI_SAMPLERATES: + case SR_DI_PROBE_NAMES: + info = probe_names; + break; + case SR_DI_SAMPLERATES: info = &samplerates; break; - case DI_TRIGGER_TYPES: + case SR_DI_TRIGGER_TYPES: info = (char *)TRIGGER_TYPES; break; - case DI_CUR_SAMPLERATE: - info = &cur_samplerate; + case SR_DI_CUR_SAMPLERATE: + info = &ols->cur_samplerate; break; } @@ -405,7 +580,7 @@ static int hw_get_status(int device_index) struct sr_device_instance *sdi; if (!(sdi = sr_get_device_instance(device_instances, device_index))) - return ST_NOT_FOUND; + return SR_ST_NOT_FOUND; return sdi->status; } @@ -418,25 +593,32 @@ static int *hw_get_capabilities(void) static int set_configuration_samplerate(struct sr_device_instance *sdi, uint64_t samplerate) { - uint32_t divider; + struct ols_device *ols; - if (samplerate < samplerates.low || samplerate > samplerates.high) + ols = sdi->priv; + if (ols->max_samplerate) { + if (samplerate > ols->max_samplerate) + return SR_ERR_SAMPLERATE; + } else if (samplerate < samplerates.low || samplerate > samplerates.high) return SR_ERR_SAMPLERATE; if (samplerate > CLOCK_RATE) { - flag_reg |= FLAG_DEMUX; - divider = (CLOCK_RATE * 2 / samplerate) - 1; + ols->flag_reg |= FLAG_DEMUX; + ols->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1; } else { - flag_reg &= ~FLAG_DEMUX; - divider = (CLOCK_RATE / samplerate) - 1; + ols->flag_reg &= ~FLAG_DEMUX; + ols->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1; } - g_message("ols: setting samplerate to %" PRIu64 " Hz (divider %u, demux %s)", - samplerate, divider, flag_reg & FLAG_DEMUX ? "on" : "off"); - - if (send_longcommand(sdi->serial->fd, CMD_SET_DIVIDER, reverse32(divider)) != SR_OK) - return SR_ERR; - cur_samplerate = samplerate; + /* Calculate actual samplerate used and complain if it is different + * from the requested. + */ + ols->cur_samplerate = CLOCK_RATE / (ols->cur_samplerate_divider + 1); + if (ols->flag_reg & FLAG_DEMUX) + ols->cur_samplerate *= 2; + if (ols->cur_samplerate != samplerate) + sr_err("ols: can't match samplerate %" PRIu64 ", using %" + PRIu64, samplerate, ols->cur_samplerate); return SR_OK; } @@ -444,40 +626,51 @@ static int set_configuration_samplerate(struct sr_device_instance *sdi, static int hw_set_configuration(int device_index, int capability, void *value) { struct sr_device_instance *sdi; + struct ols_device *ols; int ret; uint64_t *tmp_u64; if (!(sdi = sr_get_device_instance(device_instances, device_index))) return SR_ERR; + ols = sdi->priv; - if (sdi->status != ST_ACTIVE) + if (sdi->status != SR_ST_ACTIVE) return SR_ERR; switch (capability) { - case HWCAP_SAMPLERATE: + case SR_HWCAP_SAMPLERATE: tmp_u64 = value; ret = set_configuration_samplerate(sdi, *tmp_u64); break; - case HWCAP_PROBECONFIG: - ret = configure_probes((GSList *) value); + case SR_HWCAP_PROBECONFIG: + ret = configure_probes(ols, (GSList *) value); break; - case HWCAP_LIMIT_SAMPLES: + case SR_HWCAP_LIMIT_SAMPLES: tmp_u64 = value; if (*tmp_u64 < MIN_NUM_SAMPLES) return SR_ERR; - limit_samples = *tmp_u64; - g_message("ols: sample limit %" PRIu64, limit_samples); + if (*tmp_u64 > ols->max_samples) + sr_err("ols: sample limit exceeds hw max"); + ols->limit_samples = *tmp_u64; + sr_info("ols: sample limit %" PRIu64, ols->limit_samples); ret = SR_OK; break; - case HWCAP_CAPTURE_RATIO: + case SR_HWCAP_CAPTURE_RATIO: tmp_u64 = value; - capture_ratio = *tmp_u64; - if (capture_ratio < 0 || capture_ratio > 100) { - capture_ratio = 0; + ols->capture_ratio = *tmp_u64; + if (ols->capture_ratio < 0 || ols->capture_ratio > 100) { + ols->capture_ratio = 0; ret = SR_ERR; } else ret = SR_OK; break; + case SR_HWCAP_RLE: + if (GPOINTER_TO_INT(value)) { + sr_info("ols: enabling RLE"); + ols->flag_reg |= FLAG_RLE; + } + ret = SR_OK; + break; default: ret = SR_ERR; } @@ -485,78 +678,90 @@ static int hw_set_configuration(int device_index, int capability, void *value) return ret; } -static int receive_data(int fd, int revents, void *user_data) +static int receive_data(int fd, int revents, void *session_data) { - static unsigned int num_transfers = 0; - static int num_bytes = 0; - static char last_sample[4] = { 0xff, 0xff, 0xff, 0xff }; - static unsigned char sample[4] = { 0, 0, 0, 0 }; - static unsigned char tmp_sample[4]; - static unsigned char *raw_sample_buf = NULL; - int count, buflen, num_channels, offset, i, j; - struct datafeed_packet packet; - unsigned char byte, *buffer; - - if (num_transfers++ == 0) { + struct sr_datafeed_packet packet; + struct sr_datafeed_logic logic; + struct sr_device_instance *sdi; + struct ols_device *ols; + GSList *l; + int num_channels, offset, i, j; + unsigned char byte; + + /* find this device's ols_device struct by its fd */ + ols = NULL; + for (l = device_instances; l; l = l->next) { + sdi = l->data; + if (ols->serial->fd == fd) { + ols = sdi->priv; + break; + } + } + if (!ols) + /* shouldn't happen */ + return TRUE; + + if (ols->num_transfers++ == 0) { /* * First time round, means the device started sending data, * and will not stop until done. If it stops sending for * longer than it takes to send a byte, that means it's * finished. We'll double that to 30ms to be sure... */ - source_remove(fd); - source_add(fd, G_IO_IN, 30, receive_data, user_data); - raw_sample_buf = malloc(limit_samples * 4); + sr_source_remove(fd); + sr_source_add(fd, G_IO_IN, 30, receive_data, session_data); + ols->raw_sample_buf = g_try_malloc(ols->limit_samples * 4); + if (!ols->raw_sample_buf) { + sr_err("ols: %s: ols->raw_sample_buf malloc failed", + __func__); + return FALSE; + } /* fill with 1010... for debugging */ - memset(raw_sample_buf, 0x82, limit_samples * 4); + memset(ols->raw_sample_buf, 0x82, ols->limit_samples * 4); } num_channels = 0; for (i = 0x20; i > 0x02; i /= 2) { - if ((flag_reg & i) == 0) + if ((ols->flag_reg & i) == 0) num_channels++; } - if (revents == G_IO_IN - && num_transfers / num_channels <= limit_samples) { + if (revents == G_IO_IN) { if (serial_read(fd, &byte, 1) != 1) return FALSE; - sample[num_bytes++] = byte; - g_debug("ols: received byte 0x%.2x", byte); - if (num_bytes == num_channels) { - g_debug("ols: received sample 0x%.*x", num_bytes * 2, (int) *sample); + /* Ignore it if we've read enough. */ + if (ols->num_samples >= ols->limit_samples) + return TRUE; + + ols->sample[ols->num_bytes++] = byte; + sr_dbg("ols: received byte 0x%.2x", byte); + if (ols->num_bytes == num_channels) { /* Got a full sample. */ - if (flag_reg & FLAG_RLE) { + sr_dbg("ols: received sample 0x%.*x", + ols->num_bytes * 2, *(int *)ols->sample); + if (ols->flag_reg & FLAG_RLE) { /* * In RLE mode -1 should never come in as a * sample, because bit 31 is the "count" flag. - * TODO: Endianness may be wrong here, could be - * sample[3]. */ - if (sample[0] & 0x80 - && !(last_sample[0] & 0x80)) { - count = (int)(*sample) & 0x7fffffff; - buffer = g_malloc(count); - buflen = 0; - for (i = 0; i < count; i++) { - memcpy(buffer + buflen, last_sample, 4); - buflen += 4; - } - } else { + if (ols->sample[ols->num_bytes - 1] & 0x80) { + ols->sample[ols->num_bytes - 1] &= 0x7f; /* - * Just a single sample, next sample - * will probably be a count referring - * to this -- but this one is still a - * part of the stream. + * FIXME: This will only work on + * little-endian systems. */ - buffer = sample; - buflen = 4; + ols->rle_count = *(int *)(ols->sample); + sr_dbg("ols: RLE count = %d", ols->rle_count); + ols->num_bytes = 0; + return TRUE; } - } else { - /* No compression. */ - buffer = sample; - buflen = 4; + } + ols->num_samples += ols->rle_count + 1; + if (ols->num_samples > ols->limit_samples) { + /* Save us from overrunning the buffer. */ + ols->rle_count -= ols->num_samples - ols->limit_samples; + ols->num_samples = ols->limit_samples; } if (num_channels < 4) { @@ -570,35 +775,33 @@ static int receive_data(int fd, int revents, void *user_data) * the number of probes. */ j = 0; - memset(tmp_sample, 0, 4); + memset(ols->tmp_sample, 0, 4); for (i = 0; i < 4; i++) { - if (((flag_reg >> 2) & (1 << i)) == 0) { + if (((ols->flag_reg >> 2) & (1 << i)) == 0) { /* * This channel group was * enabled, copy from received * sample. */ - tmp_sample[i] = sample[j++]; + ols->tmp_sample[i] = ols->sample[j++]; } } - memcpy(sample, tmp_sample, 4); - g_debug("ols: full sample 0x%.8x", (int) *sample); + memcpy(ols->sample, ols->tmp_sample, 4); + sr_dbg("ols: full sample 0x%.8x", *(int *)ols->sample); } /* the OLS sends its sample buffer backwards. * store it in reverse order here, so we can dump * this on the session bus later. */ - offset = (limit_samples - num_transfers / num_channels) * 4; - memcpy(raw_sample_buf + offset, sample, 4); - - if (buffer == sample) - memcpy(last_sample, buffer, num_channels); - else - g_free(buffer); - - memset(sample, 0, 4); - num_bytes = 0; + offset = (ols->limit_samples - ols->num_samples) * 4; + for (i = 0; i <= ols->rle_count; i++) { + memcpy(ols->raw_sample_buf + offset + (i * 4), + ols->sample, 4); + } + memset(ols->sample, 0, 4); + ols->num_bytes = 0; + ols->rle_count = 0; } } else { /* @@ -606,171 +809,201 @@ static int receive_data(int fd, int revents, void *user_data) * we've acquired all the samples we asked for -- we're done. * Send the (properly-ordered) buffer to the frontend. */ - if (trigger_at != -1) { + if (ols->trigger_at != -1) { /* a trigger was set up, so we need to tell the frontend * about it. */ - if (trigger_at > 0) { + if (ols->trigger_at > 0) { /* there are pre-trigger samples, send those first */ - packet.type = DF_LOGIC; - packet.length = trigger_at * 4; - packet.unitsize = 4; - packet.payload = raw_sample_buf; - session_bus(user_data, &packet); + packet.type = SR_DF_LOGIC; + packet.payload = &logic; + logic.length = ols->trigger_at * 4; + logic.unitsize = 4; + logic.data = ols->raw_sample_buf + + (ols->limit_samples - ols->num_samples) * 4; + sr_session_bus(session_data, &packet); } - packet.type = DF_TRIGGER; - packet.length = 0; - session_bus(user_data, &packet); - - packet.type = DF_LOGIC; - packet.length = (limit_samples * 4) - (trigger_at * 4); - packet.unitsize = 4; - packet.payload = raw_sample_buf + trigger_at * 4; - session_bus(user_data, &packet); + /* send the trigger */ + packet.type = SR_DF_TRIGGER; + sr_session_bus(session_data, &packet); + + /* send post-trigger samples */ + packet.type = SR_DF_LOGIC; + packet.payload = &logic; + logic.length = (ols->num_samples * 4) - (ols->trigger_at * 4); + logic.unitsize = 4; + logic.data = ols->raw_sample_buf + ols->trigger_at * 4 + + (ols->limit_samples - ols->num_samples) * 4; + sr_session_bus(session_data, &packet); } else { - packet.type = DF_LOGIC; - packet.length = limit_samples * 4; - packet.unitsize = 4; - packet.payload = raw_sample_buf; - session_bus(user_data, &packet); + /* no trigger was used */ + packet.type = SR_DF_LOGIC; + packet.payload = &logic; + logic.length = ols->num_samples * 4; + logic.unitsize = 4; + logic.data = ols->raw_sample_buf + + (ols->limit_samples - ols->num_samples) * 4; + sr_session_bus(session_data, &packet); } - free(raw_sample_buf); + g_free(ols->raw_sample_buf); serial_flush(fd); serial_close(fd); - packet.type = DF_END; - packet.length = 0; - session_bus(user_data, &packet); + packet.type = SR_DF_END; + sr_session_bus(session_data, &packet); } return TRUE; } -static int hw_start_acquisition(int device_index, gpointer session_device_id) +static int hw_start_acquisition(int device_index, gpointer session_data) { - int i; - struct datafeed_packet *packet; - struct datafeed_header *header; + struct sr_datafeed_packet *packet; + struct sr_datafeed_header *header; struct sr_device_instance *sdi; + struct ols_device *ols; uint32_t trigger_config[4]; uint32_t data; uint16_t readcount, delaycount; uint8_t changrp_mask; + int num_channels; + int i; if (!(sdi = sr_get_device_instance(device_instances, device_index))) return SR_ERR; - if (sdi->status != ST_ACTIVE) + ols = sdi->priv; + + if (sdi->status != SR_ST_ACTIVE) return SR_ERR; - readcount = limit_samples / 4; + /* + * 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 (ols->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(ols->max_samples / num_channels, ols->limit_samples) / 4; memset(trigger_config, 0, 16); - trigger_config[num_stages-1] |= 0x08; - if (trigger_mask[0]) { - delaycount = readcount * (1 - capture_ratio / 100.0); - trigger_at = (readcount - delaycount) * 4 - num_stages; + trigger_config[ols->num_stages - 1] |= 0x08; + if (ols->trigger_mask[0]) { + delaycount = readcount * (1 - ols->capture_ratio / 100.0); + ols->trigger_at = (readcount - delaycount) * 4 - ols->num_stages; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_0, - reverse32(trigger_mask[0])) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_0, + reverse32(ols->trigger_mask[0])) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_0, - reverse32(trigger_value[0])) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_0, + reverse32(ols->trigger_value[0])) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_0, + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_0, trigger_config[0]) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_1, - reverse32(trigger_mask[1])) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_1, + reverse32(ols->trigger_mask[1])) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_1, - reverse32(trigger_value[1])) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_1, + reverse32(ols->trigger_value[1])) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_1, + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_1, trigger_config[1]) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_2, - reverse32(trigger_mask[2])) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_2, + reverse32(ols->trigger_mask[2])) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_2, - reverse32(trigger_value[2])) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_2, + reverse32(ols->trigger_value[2])) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_2, + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_2, trigger_config[2]) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_3, - reverse32(trigger_mask[3])) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_3, + reverse32(ols->trigger_mask[3])) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_3, - reverse32(trigger_value[3])) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_3, + reverse32(ols->trigger_value[3])) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_3, + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_3, trigger_config[3]) != SR_OK) return SR_ERR; } else { - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_MASK_0, - trigger_mask[0]) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_0, + ols->trigger_mask[0]) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_VALUE_0, - trigger_value[0]) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_0, + ols->trigger_value[0]) != SR_OK) return SR_ERR; - if (send_longcommand(sdi->serial->fd, CMD_SET_TRIGGER_CONFIG_0, + if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_0, 0x00000008) != SR_OK) return SR_ERR; delaycount = readcount; } - set_configuration_samplerate(sdi, cur_samplerate); + sr_info("ols: setting samplerate to %" PRIu64 " Hz (divider %u, " + "demux %s)", ols->cur_samplerate, ols->cur_samplerate_divider, + ols->flag_reg & FLAG_DEMUX ? "on" : "off"); + if (send_longcommand(ols->serial->fd, CMD_SET_DIVIDER, + reverse32(ols->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(sdi->serial->fd, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK) + if (send_longcommand(ols->serial->fd, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK) return SR_ERR; - /* - * Enable/disable channel groups in the flag register according to the - * probe mask. - */ - changrp_mask = 0; - for (i = 0; i < 4; i++) { - if (probe_mask & (0xff << (i * 8))) - changrp_mask |= (1 << i); - } - /* The flag register wants them here, and 1 means "disable channel". */ - flag_reg |= ~(changrp_mask << 2) & 0x3c; - flag_reg |= FLAG_FILTER; - data = flag_reg << 24; - if (send_longcommand(sdi->serial->fd, CMD_SET_FLAGS, data) != SR_OK) + ols->flag_reg |= ~(changrp_mask << 2) & 0x3c; + ols->flag_reg |= FLAG_FILTER; + ols->rle_count = 0; + data = (ols->flag_reg << 24) | ((ols->flag_reg << 8) & 0xff0000); + if (send_longcommand(ols->serial->fd, CMD_SET_FLAGS, data) != SR_OK) return SR_ERR; /* Start acquisition on the device. */ - if (send_shortcommand(sdi->serial->fd, CMD_RUN) != SR_OK) + if (send_shortcommand(ols->serial->fd, CMD_RUN) != SR_OK) return SR_ERR; - source_add(sdi->serial->fd, G_IO_IN, -1, receive_data, - session_device_id); + sr_source_add(ols->serial->fd, G_IO_IN, -1, receive_data, + session_data); + + if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) { + sr_err("ols: %s: packet malloc failed", __func__); + return SR_ERR_MALLOC; + } + + if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) { + sr_err("ols: %s: header malloc failed", __func__); + g_free(packet); + return SR_ERR_MALLOC; + } /* Send header packet to the session bus. */ - packet = g_malloc(sizeof(struct datafeed_packet)); - header = g_malloc(sizeof(struct datafeed_header)); - if (!packet || !header) - return SR_ERR; - packet->type = DF_HEADER; - packet->length = sizeof(struct datafeed_header); + packet->type = SR_DF_HEADER; packet->payload = (unsigned char *)header; header->feed_version = 1; gettimeofday(&header->starttime, NULL); - header->samplerate = cur_samplerate; - header->protocol_id = PROTO_RAW; + header->samplerate = ols->cur_samplerate; header->num_logic_probes = NUM_PROBES; - header->num_analog_probes = 0; - session_bus(session_device_id, packet); + sr_session_bus(session_data, packet); + g_free(header); g_free(packet); @@ -779,27 +1012,27 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id) static void hw_stop_acquisition(int device_index, gpointer session_device_id) { - struct datafeed_packet packet; + struct sr_datafeed_packet packet; /* Avoid compiler warnings. */ - device_index = device_index; + (void)device_index; - packet.type = DF_END; - packet.length = 0; - session_bus(session_device_id, &packet); + packet.type = SR_DF_END; + sr_session_bus(session_device_id, &packet); } -struct device_plugin ols_plugin_info = { - "ols", - 1, - hw_init, - hw_cleanup, - hw_opendev, - hw_closedev, - hw_get_device_info, - hw_get_status, - hw_get_capabilities, - hw_set_configuration, - hw_start_acquisition, - hw_stop_acquisition, +SR_PRIV struct sr_device_plugin ols_plugin_info = { + .name = "ols", + .longname = "Openbench Logic Sniffer", + .api_version = 1, + .init = hw_init, + .cleanup = hw_cleanup, + .opendev = hw_opendev, + .closedev = hw_closedev, + .get_device_info = hw_get_device_info, + .get_status = hw_get_status, + .get_capabilities = hw_get_capabilities, + .set_configuration = hw_set_configuration, + .start_acquisition = hw_start_acquisition, + .stop_acquisition = hw_stop_acquisition, };