X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fopenbench-logic-sniffer%2Fols.c;h=596e7f8425356e7cc9869681387c47eb54c6c406;hb=a567547e205eca58065f21aa5b1502a34ba315b3;hp=930d008557f9101203446104fe35648e9f5d8861;hpb=3010f21c9170e9f235d49bc7b333d17677c70e5c;p=libsigrok.git diff --git a/hardware/openbench-logic-sniffer/ols.c b/hardware/openbench-logic-sniffer/ols.c index 930d0085..596e7f84 100644 --- a/hardware/openbench-logic-sniffer/ols.c +++ b/hardware/openbench-logic-sniffer/ols.c @@ -38,15 +38,13 @@ #include #endif #include -#include "sigrok.h" -#include "sigrok-internal.h" +#include "libsigrok.h" +#include "libsigrok-internal.h" #include "ols.h" -#ifdef _WIN32 -#define O_NONBLOCK FIONBIO -#endif +#define SERIALCOMM "115200/8n1" -static int capabilities[] = { +static const int hwcaps[] = { SR_HWCAP_LOGIC_ANALYZER, SR_HWCAP_SAMPLERATE, SR_HWCAP_CAPTURE_RATIO, @@ -55,6 +53,7 @@ static int capabilities[] = { 0, }; +/* Probes are numbered 0-31 (on the PCB silkscreen). */ static const char *probe_names[NUM_PROBES + 1] = { "0", "1", @@ -92,60 +91,65 @@ static const char *probe_names[NUM_PROBES + 1] = { }; /* default supported samplerates, can be overridden by device metadata */ -static struct sr_samplerates samplerates = { +static const struct sr_samplerates samplerates = { SR_HZ(10), SR_MHZ(200), SR_HZ(1), NULL, }; -/* List of struct sr_serial_device_instance */ -static GSList *device_instances = NULL; +SR_PRIV struct sr_dev_driver ols_driver_info; +static struct sr_dev_driver *di = &ols_driver_info; -static int send_shortcommand(int fd, uint8_t command) +static int send_shortcommand(struct sr_serial_dev_inst *serial, + uint8_t command) { char buf[1]; - sr_dbg("ols: sending cmd 0x%.2x", command); + sr_dbg("Sending cmd 0x%.2x.", command); buf[0] = command; - if (serial_write(fd, buf, 1) != 1) + if (serial_write(serial, buf, 1) != 1) return SR_ERR; return SR_OK; } -static int send_longcommand(int fd, uint8_t command, uint32_t data) +static int send_longcommand(struct sr_serial_dev_inst *serial, + uint8_t command, uint32_t data) { char buf[5]; - sr_dbg("ols: sending cmd 0x%.2x data 0x%.8x", command, data); + sr_dbg("Sending cmd 0x%.2x data 0x%.8x.", command, data); buf[0] = command; buf[1] = (data & 0xff000000) >> 24; buf[2] = (data & 0xff0000) >> 16; buf[3] = (data & 0xff00) >> 8; buf[4] = data & 0xff; - if (serial_write(fd, buf, 5) != 5) + if (serial_write(serial, buf, 5) != 5) return SR_ERR; return SR_OK; } -static int configure_probes(struct ols_device *ols, GSList *probes) +static int configure_probes(const struct sr_dev_inst *sdi) { - struct sr_probe *probe; - GSList *l; + struct dev_context *devc; + const struct sr_probe *probe; + const GSList *l; int probe_bit, stage, i; char *tc; - ols->probe_mask = 0; + devc = sdi->priv; + + devc->probe_mask = 0; for (i = 0; i < NUM_TRIGGER_STAGES; i++) { - ols->trigger_mask[i] = 0; - ols->trigger_value[i] = 0; + devc->trigger_mask[i] = 0; + devc->trigger_value[i] = 0; } - ols->num_stages = 0; - for (l = probes; l; l = l->next) { - probe = (struct sr_probe *)l->data; + devc->num_stages = 0; + for (l = sdi->probes; l; l = l->next) { + probe = (const struct sr_probe *)l->data; if (!probe->enabled) continue; @@ -153,8 +157,8 @@ static int configure_probes(struct ols_device *ols, GSList *probes) * Set up the probe mask for later configuration into the * flag register. */ - probe_bit = 1 << (probe->index - 1); - ols->probe_mask |= probe_bit; + probe_bit = 1 << (probe->index); + devc->probe_mask |= probe_bit; if (!probe->trigger) continue; @@ -162,9 +166,9 @@ static int configure_probes(struct ols_device *ols, GSList *probes) /* Configure trigger mask and value. */ stage = 0; for (tc = probe->trigger; tc && *tc; tc++) { - ols->trigger_mask[stage] |= probe_bit; + devc->trigger_mask[stage] |= probe_bit; if (*tc == '1') - ols->trigger_value[stage] |= probe_bit; + devc->trigger_value[stage] |= probe_bit; stage++; if (stage > 3) /* @@ -173,8 +177,8 @@ static int configure_probes(struct ols_device *ols, GSList *probes) */ return SR_ERR; } - if (stage > ols->num_stages) - ols->num_stages = stage; + if (stage > devc->num_stages) + devc->num_stages = stage; } return SR_OK; @@ -204,43 +208,44 @@ static uint32_t reverse32(uint32_t in) return out; } -static struct ols_device *ols_device_new(void) +static struct dev_context *ols_dev_new(void) { - struct ols_device *ols; + struct dev_context *devc; - /* TODO: Is 'ols' ever g_free()'d? */ - if (!(ols = g_try_malloc0(sizeof(struct ols_device)))) { - sr_err("ols: %s: ols malloc failed", __func__); + if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) { + sr_err("Device context malloc failed."); return NULL; } - ols->trigger_at = -1; - ols->probe_mask = 0xffffffff; - ols->cur_samplerate = SR_KHZ(200); - ols->serial = NULL; + devc->trigger_at = -1; + devc->probe_mask = 0xffffffff; + devc->cur_samplerate = SR_KHZ(200); + devc->serial = NULL; - return ols; + return devc; } -static struct sr_device_instance *get_metadata(int fd) +static struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial) { - struct sr_device_instance *sdi; - struct ols_device *ols; - uint32_t tmp_int; + struct sr_dev_inst *sdi; + struct dev_context *devc; + struct sr_probe *probe; + uint32_t tmp_int, ui; uint8_t key, type, token; - GString *tmp_str, *devicename, *version; - gchar tmp_c; + GString *tmp_str, *devname, *version; + guchar tmp_c; - sdi = sr_device_instance_new(0, SR_ST_INACTIVE, NULL, NULL, NULL); - ols = ols_device_new(); - sdi->priv = ols; + sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, NULL, NULL, NULL); + sdi->driver = di; + devc = ols_dev_new(); + sdi->priv = devc; - devicename = g_string_new(""); + devname = g_string_new(""); version = g_string_new(""); key = 0xff; while (key) { - if (serial_read(fd, &key, 1) != 1 || key == 0x00) + if (serial_read(serial, &key, 1) != 1 || key == 0x00) break; type = key >> 5; token = key & 0x1f; @@ -248,14 +253,14 @@ static struct sr_device_instance *get_metadata(int fd) case 0: /* NULL-terminated string */ tmp_str = g_string_new(""); - while (serial_read(fd, &tmp_c, 1) == 1 && tmp_c != '\0') + while (serial_read(serial, &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'", + sr_dbg("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); + devname = g_string_append(devname, tmp_str->str); break; case 0x02: /* FPGA firmware version */ @@ -280,19 +285,24 @@ static struct sr_device_instance *get_metadata(int fd) break; case 1: /* 32-bit unsigned integer */ - if (serial_read(fd, &tmp_int, 4) != 4) + if (serial_read(serial, &tmp_int, 4) != 4) break; tmp_int = reverse32(tmp_int); - sr_dbg("ols: got metadata key 0x%.2x value 0x%.8x", + sr_dbg("Got metadata key 0x%.2x value 0x%.8x.", key, tmp_int); switch (token) { case 0x00: /* Number of usable probes */ - ols->num_probes = tmp_int; + for (ui = 0; ui < tmp_int; ui++) { + if (!(probe = sr_probe_new(ui, SR_PROBE_LOGIC, TRUE, + probe_names[ui]))) + return 0; + sdi->probes = g_slist_append(sdi->probes, probe); + } break; case 0x01: /* Amount of sample memory available (bytes) */ - ols->max_samples = tmp_int; + devc->max_samples = tmp_int; break; case 0x02: /* Amount of dynamic memory available (bytes) */ @@ -300,35 +310,40 @@ static struct sr_device_instance *get_metadata(int fd) break; case 0x03: /* Maximum sample rate (hz) */ - ols->max_samplerate = tmp_int; + devc->max_samplerate = tmp_int; break; case 0x04: /* protocol version */ - ols->protocol_version = tmp_int; + devc->protocol_version = tmp_int; break; default: - sr_info("ols: unknown token 0x%.2x: 0x%.8x", + sr_info("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) + if (serial_read(serial, &tmp_c, 1) != 1) break; - sr_dbg("ols: got metadata key 0x%.2x value 0x%.2x", + sr_dbg("Got metadata key 0x%.2x value 0x%.2x.", key, tmp_c); switch (token) { case 0x00: /* Number of usable probes */ - ols->num_probes = tmp_c; + for (ui = 0; ui < tmp_c; ui++) { + if (!(probe = sr_probe_new(ui, SR_PROBE_LOGIC, TRUE, + probe_names[ui]))) + return 0; + sdi->probes = g_slist_append(sdi->probes, probe); + } break; case 0x01: /* protocol version */ - ols->protocol_version = tmp_c; + devc->protocol_version = tmp_c; break; default: - sr_info("ols: unknown token 0x%.2x: 0x%.2x", + sr_info("Unknown token 0x%.2x: 0x%.2x.", token, tmp_c); break; } @@ -339,159 +354,153 @@ static struct sr_device_instance *get_metadata(int fd) } } - sdi->model = devicename->str; + sdi->model = devname->str; sdi->version = version->str; - g_string_free(devicename, FALSE); + g_string_free(devname, FALSE); g_string_free(version, FALSE); return sdi; } -static int hw_init(const char *deviceinfo) +static int hw_init(struct sr_context *sr_ctx) { - struct sr_device_instance *sdi; - struct ols_device *ols; - GSList *ports, *l; - 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, g_strdup(deviceinfo)); - else - /* No specific device given, so scan all serial ports. */ - ports = list_serial_ports(); - - num_ports = g_slist_length(ports); - - 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. */ - } + struct drv_context *drvc; - 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 (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) { + sr_err("Driver context malloc failed."); + return SR_ERR_MALLOC; } + drvc->sr_ctx = sr_ctx; + di->priv = drvc; - 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. */ - } + return SR_OK; +} - devcnt = 0; - for (l = ports; l; l = l->next) { - /* 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. - * - * Since it may take the device a while to respond at 115Kb/s, - * we do all the sending first, then wait for all of them to - * respond with g_poll(). - */ - 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); - serial_set_params(fd, 115200, 8, 0, 1, 2); - ret = SR_OK; - for (i = 0; i < 5; i++) { - if ((ret = send_shortcommand(fd, - CMD_RESET)) != SR_OK) { - /* Serial port is not writable. */ - break; - } - } - if (ret != SR_OK) { - serial_restore_params(fd, - serial_params[devcnt]); - serial_close(fd); - continue; - } - send_shortcommand(fd, CMD_ID); - fds[devcnt].fd = fd; - fds[devcnt].events = G_IO_IN; - device_names[devcnt] = g_strdup(l->data); - devcnt++; +static GSList *hw_scan(GSList *options) +{ + struct sr_hwopt *opt; + 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) { + opt = l->data; + switch (opt->hwopt) { + case SR_HWOPT_CONN: + conn = opt->value; + break; + case SR_HWOPT_SERIALCOMM: + serialcomm = opt->value; + break; } - g_free(l->data); } + if (!conn) + return NULL; - /* 2ms isn't enough for reliable transfer with pl2303, let's try 10 */ - usleep(10000); + if (serialcomm == NULL) + serialcomm = SERIALCOMM; - g_poll(fds, devcnt, 1); + if (!(serial = sr_serial_dev_inst_new(conn, serialcomm))) + return NULL; - for (i = 0; i < devcnt; 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; + /* 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; - /* 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; + 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; } - 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; } + 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. */ + 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; - /* 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); + /* 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, + probe_names[i]))) + return 0; + sdi->probes = g_slist_append(sdi->probes, probe); } - g_free(serial_params[i]); - g_free(device_names[i]); + sdi->priv = devc; } + devc->serial = serial; + drvc->instances = g_slist_append(drvc->instances, sdi); + devices = g_slist_append(devices, sdi); - 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); + serial_close(serial); - return final_devcnt; + return devices; } -static int hw_opendev(int device_index) +static GSList *hw_dev_list(void) { - struct sr_device_instance *sdi; - struct ols_device *ols; + struct drv_context *drvc; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) - return SR_ERR; + drvc = di->priv; - ols = sdi->priv; + return drvc->instances; +} + +static int hw_dev_open(struct sr_dev_inst *sdi) +{ + struct dev_context *devc; - ols->serial->fd = serial_open(ols->serial->port, O_RDWR); - if (ols->serial->fd == -1) + devc = sdi->priv; + + if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK) return SR_ERR; sdi->status = SR_ST_ACTIVE; @@ -499,175 +508,160 @@ static int hw_opendev(int device_index) return SR_OK; } -static int hw_closedev(int device_index) +static int hw_dev_close(struct sr_dev_inst *sdi) { - struct sr_device_instance *sdi; - struct ols_device *ols; - - 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? */ - } + struct dev_context *devc; - ols = sdi->priv; + devc = sdi->priv; - /* TODO */ - if (ols->serial->fd != -1) { - serial_close(ols->serial->fd); - ols->serial->fd = -1; + if (devc->serial && devc->serial->fd != -1) { + serial_close(devc->serial); sdi->status = SR_ST_INACTIVE; } return SR_OK; } -static void hw_cleanup(void) +static int hw_cleanup(void) { GSList *l; - struct sr_device_instance *sdi; - struct ols_device *ols; + 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 = device_instances; l; l = l->next) { - sdi = l->data; - 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); + 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(device_instances); - device_instances = NULL; + g_slist_free(drvc->instances); + drvc->instances = NULL; + + return ret; } -static void *hw_get_device_info(int device_index, int device_info_id) +static int hw_info_get(int info_id, const void **data, + const struct sr_dev_inst *sdi) { - 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; + struct dev_context *devc; - info = NULL; - switch (device_info_id) { - case SR_DI_INSTANCE: - info = sdi; + switch (info_id) { + case SR_DI_HWCAPS: + *data = hwcaps; break; case SR_DI_NUM_PROBES: - info = GINT_TO_POINTER(NUM_PROBES); + *data = GINT_TO_POINTER(1); break; case SR_DI_PROBE_NAMES: - info = probe_names; + *data = probe_names; break; case SR_DI_SAMPLERATES: - info = &samplerates; + *data = &samplerates; break; case SR_DI_TRIGGER_TYPES: - info = (char *)TRIGGER_TYPES; + *data = (char *)TRIGGER_TYPES; break; case SR_DI_CUR_SAMPLERATE: - info = &ols->cur_samplerate; + if (sdi) { + devc = sdi->priv; + *data = &devc->cur_samplerate; + } else + return SR_ERR; break; + default: + return SR_ERR_ARG; } - return info; -} - -static int hw_get_status(int device_index) -{ - struct sr_device_instance *sdi; - - if (!(sdi = sr_get_device_instance(device_instances, device_index))) - return SR_ST_NOT_FOUND; - - return sdi->status; -} - -static int *hw_get_capabilities(void) -{ - return capabilities; + return SR_OK; } -static int set_configuration_samplerate(struct sr_device_instance *sdi, - uint64_t samplerate) +static int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate) { - struct ols_device *ols; + struct dev_context *devc; - ols = sdi->priv; - if (ols->max_samplerate) { - if (samplerate > ols->max_samplerate) + devc = sdi->priv; + if (devc->max_samplerate) { + if (samplerate > devc->max_samplerate) return SR_ERR_SAMPLERATE; } else if (samplerate < samplerates.low || samplerate > samplerates.high) return SR_ERR_SAMPLERATE; if (samplerate > CLOCK_RATE) { - ols->flag_reg |= FLAG_DEMUX; - ols->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1; + devc->flag_reg |= FLAG_DEMUX; + devc->cur_samplerate_divider = (CLOCK_RATE * 2 / samplerate) - 1; } else { - ols->flag_reg &= ~FLAG_DEMUX; - ols->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1; + devc->flag_reg &= ~FLAG_DEMUX; + devc->cur_samplerate_divider = (CLOCK_RATE / samplerate) - 1; } /* 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); + devc->cur_samplerate = CLOCK_RATE / (devc->cur_samplerate_divider + 1); + if (devc->flag_reg & FLAG_DEMUX) + devc->cur_samplerate *= 2; + if (devc->cur_samplerate != samplerate) + sr_err("Can't match samplerate %" PRIu64 ", using %" + PRIu64 ".", samplerate, devc->cur_samplerate); return SR_OK; } -static int hw_set_configuration(int device_index, int capability, void *value) +static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, + const void *value) { - struct sr_device_instance *sdi; - struct ols_device *ols; + struct dev_context *devc; int ret; - uint64_t *tmp_u64; + const uint64_t *tmp_u64; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) - return SR_ERR; - ols = sdi->priv; + devc = sdi->priv; if (sdi->status != SR_ST_ACTIVE) return SR_ERR; - switch (capability) { + switch (hwcap) { case SR_HWCAP_SAMPLERATE: - tmp_u64 = value; - ret = set_configuration_samplerate(sdi, *tmp_u64); - break; - case SR_HWCAP_PROBECONFIG: - ret = configure_probes(ols, (GSList *) value); + ret = set_samplerate(sdi, *(const uint64_t *)value); break; case SR_HWCAP_LIMIT_SAMPLES: tmp_u64 = value; if (*tmp_u64 < MIN_NUM_SAMPLES) return SR_ERR; - 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); + 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_HWCAP_CAPTURE_RATIO: - tmp_u64 = value; - ols->capture_ratio = *tmp_u64; - if (ols->capture_ratio < 0 || ols->capture_ratio > 100) { - ols->capture_ratio = 0; + 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_HWCAP_RLE: if (GPOINTER_TO_INT(value)) { - sr_info("ols: enabling RLE"); - ols->flag_reg |= FLAG_RLE; + sr_info("Enabling RLE."); + devc->flag_reg |= FLAG_RLE; } ret = SR_OK; break; @@ -678,30 +672,46 @@ static int hw_set_configuration(int device_index, int capability, void *value) return ret; } -static int receive_data(int fd, int revents, void *session_data) +static void abort_acquisition(const struct sr_dev_inst *sdi) +{ + struct sr_datafeed_packet packet; + struct dev_context *devc; + + devc = sdi->priv; + sr_source_remove(devc->serial->fd); + + /* Terminate session */ + packet.type = SR_DF_END; + sr_session_send(sdi, &packet); +} + +static int receive_data(int fd, int revents, void *cb_data) { struct sr_datafeed_packet packet; struct sr_datafeed_logic logic; - struct sr_device_instance *sdi; - struct ols_device *ols; + struct sr_dev_inst *sdi; + struct drv_context *drvc; + struct dev_context *devc; 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) { + drvc = di->priv; + + /* Find this device's devc struct by its fd. */ + devc = NULL; + for (l = drvc->instances; l; l = l->next) { sdi = l->data; - if (ols->serial->fd == fd) { - ols = sdi->priv; + devc = sdi->priv; + if (devc->serial->fd == fd) break; - } + devc = NULL; } - if (!ols) - /* shouldn't happen */ + if (!devc) + /* Shouldn't happen. */ return TRUE; - if (ols->num_transfers++ == 0) { + if (devc->num_transfers++ == 0) { /* * First time round, means the device started sending data, * and will not stop until done. If it stops sending for @@ -709,59 +719,58 @@ static int receive_data(int fd, int revents, void *session_data) * finished. We'll double that to 30ms to be sure... */ 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__); + sr_source_add(fd, G_IO_IN, 30, receive_data, cb_data); + devc->raw_sample_buf = g_try_malloc(devc->limit_samples * 4); + if (!devc->raw_sample_buf) { + sr_err("Sample buffer malloc failed."); return FALSE; } /* fill with 1010... for debugging */ - memset(ols->raw_sample_buf, 0x82, ols->limit_samples * 4); + memset(devc->raw_sample_buf, 0x82, devc->limit_samples * 4); } num_channels = 0; for (i = 0x20; i > 0x02; i /= 2) { - if ((ols->flag_reg & i) == 0) + if ((devc->flag_reg & i) == 0) num_channels++; } if (revents == G_IO_IN) { - if (serial_read(fd, &byte, 1) != 1) + if (serial_read(devc->serial, &byte, 1) != 1) return FALSE; /* Ignore it if we've read enough. */ - if (ols->num_samples >= ols->limit_samples) + if (devc->num_samples >= devc->limit_samples) return TRUE; - ols->sample[ols->num_bytes++] = byte; - sr_dbg("ols: received byte 0x%.2x", byte); - if (ols->num_bytes == num_channels) { + devc->sample[devc->num_bytes++] = byte; + sr_dbg("Received byte 0x%.2x.", byte); + if (devc->num_bytes == num_channels) { /* Got a full sample. */ - sr_dbg("ols: received sample 0x%.*x", - ols->num_bytes * 2, *(int *)ols->sample); - if (ols->flag_reg & FLAG_RLE) { + sr_dbg("Received sample 0x%.*x.", + devc->num_bytes * 2, *(int *)devc->sample); + if (devc->flag_reg & FLAG_RLE) { /* * In RLE mode -1 should never come in as a * sample, because bit 31 is the "count" flag. */ - if (ols->sample[ols->num_bytes - 1] & 0x80) { - ols->sample[ols->num_bytes - 1] &= 0x7f; + if (devc->sample[devc->num_bytes - 1] & 0x80) { + devc->sample[devc->num_bytes - 1] &= 0x7f; /* * FIXME: This will only work on * little-endian systems. */ - ols->rle_count = *(int *)(ols->sample); - sr_dbg("ols: RLE count = %d", ols->rle_count); - ols->num_bytes = 0; + devc->rle_count = *(int *)(devc->sample); + sr_dbg("RLE count: %d.", devc->rle_count); + devc->num_bytes = 0; return TRUE; } } - ols->num_samples += ols->rle_count + 1; - if (ols->num_samples > ols->limit_samples) { + devc->num_samples += devc->rle_count + 1; + if (devc->num_samples > devc->limit_samples) { /* Save us from overrunning the buffer. */ - ols->rle_count -= ols->num_samples - ols->limit_samples; - ols->num_samples = ols->limit_samples; + devc->rle_count -= devc->num_samples - devc->limit_samples; + devc->num_samples = devc->limit_samples; } if (num_channels < 4) { @@ -775,33 +784,33 @@ static int receive_data(int fd, int revents, void *session_data) * the number of probes. */ j = 0; - memset(ols->tmp_sample, 0, 4); + memset(devc->tmp_sample, 0, 4); for (i = 0; i < 4; i++) { - if (((ols->flag_reg >> 2) & (1 << i)) == 0) { + if (((devc->flag_reg >> 2) & (1 << i)) == 0) { /* * This channel group was * enabled, copy from received * sample. */ - ols->tmp_sample[i] = ols->sample[j++]; + devc->tmp_sample[i] = devc->sample[j++]; } } - memcpy(ols->sample, ols->tmp_sample, 4); - sr_dbg("ols: full sample 0x%.8x", *(int *)ols->sample); + memcpy(devc->sample, devc->tmp_sample, 4); + sr_dbg("Full sample: 0x%.8x.", *(int *)devc->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 = (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); + offset = (devc->limit_samples - devc->num_samples) * 4; + for (i = 0; i <= devc->rle_count; i++) { + memcpy(devc->raw_sample_buf + offset + (i * 4), + devc->sample, 4); } - memset(ols->sample, 0, 4); - ols->num_bytes = 0; - ols->rle_count = 0; + memset(devc->sample, 0, 4); + devc->num_bytes = 0; + devc->rle_count = 0; } } else { /* @@ -809,60 +818,60 @@ static int receive_data(int fd, int revents, void *session_data) * we've acquired all the samples we asked for -- we're done. * Send the (properly-ordered) buffer to the frontend. */ - if (ols->trigger_at != -1) { + if (devc->trigger_at != -1) { /* a trigger was set up, so we need to tell the frontend * about it. */ - if (ols->trigger_at > 0) { + if (devc->trigger_at > 0) { /* there are pre-trigger samples, send those first */ packet.type = SR_DF_LOGIC; packet.payload = &logic; - logic.length = ols->trigger_at * 4; + logic.length = devc->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); + logic.data = devc->raw_sample_buf + + (devc->limit_samples - devc->num_samples) * 4; + sr_session_send(cb_data, &packet); } /* send the trigger */ packet.type = SR_DF_TRIGGER; - sr_session_bus(session_data, &packet); + sr_session_send(cb_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.length = (devc->num_samples * 4) - (devc->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); + logic.data = devc->raw_sample_buf + devc->trigger_at * 4 + + (devc->limit_samples - devc->num_samples) * 4; + sr_session_send(cb_data, &packet); } else { /* no trigger was used */ packet.type = SR_DF_LOGIC; packet.payload = &logic; - logic.length = ols->num_samples * 4; + logic.length = devc->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); + logic.data = devc->raw_sample_buf + + (devc->limit_samples - devc->num_samples) * 4; + sr_session_send(cb_data, &packet); } - g_free(ols->raw_sample_buf); + g_free(devc->raw_sample_buf); - serial_flush(fd); - serial_close(fd); - packet.type = SR_DF_END; - sr_session_bus(session_data, &packet); + serial_flush(devc->serial); + abort_acquisition(sdi); + serial_close(devc->serial); } return TRUE; } -static int hw_start_acquisition(int device_index, gpointer session_data) +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 sr_device_instance *sdi; - struct ols_device *ols; + struct sr_datafeed_meta_logic meta; + struct dev_context *devc; uint32_t trigger_config[4]; uint32_t data; uint16_t readcount, delaycount; @@ -870,14 +879,16 @@ static int hw_start_acquisition(int device_index, gpointer session_data) int num_channels; int i; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) - return SR_ERR; - - ols = sdi->priv; + devc = sdi->priv; if (sdi->status != SR_ST_ACTIVE) return SR_ERR; + if (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 @@ -886,7 +897,7 @@ static int hw_start_acquisition(int device_index, gpointer session_data) changrp_mask = 0; num_channels = 0; for (i = 0; i < 4; i++) { - if (ols->probe_mask & (0xff << (i * 8))) { + if (devc->probe_mask & (0xff << (i * 8))) { changrp_mask |= (1 << i); num_channels++; } @@ -896,101 +907,101 @@ static int hw_start_acquisition(int device_index, gpointer session_data) * Limit readcount to prevent reading past the end of the hardware * buffer. */ - readcount = MIN(ols->max_samples / num_channels, ols->limit_samples) / 4; + readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4; memset(trigger_config, 0, 16); - 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; + 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(ols->serial->fd, CMD_SET_TRIGGER_MASK_0, - reverse32(ols->trigger_mask[0])) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0, + reverse32(devc->trigger_mask[0])) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_0, - reverse32(ols->trigger_value[0])) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0, + reverse32(devc->trigger_value[0])) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_0, + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0, trigger_config[0]) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_1, - reverse32(ols->trigger_mask[1])) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_1, + reverse32(devc->trigger_mask[1])) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_1, - reverse32(ols->trigger_value[1])) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_1, + reverse32(devc->trigger_value[1])) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_1, + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_1, trigger_config[1]) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_2, - reverse32(ols->trigger_mask[2])) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_2, + reverse32(devc->trigger_mask[2])) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_2, - reverse32(ols->trigger_value[2])) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_2, + reverse32(devc->trigger_value[2])) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_2, + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_2, trigger_config[2]) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_3, - reverse32(ols->trigger_mask[3])) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_3, + reverse32(devc->trigger_mask[3])) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_3, - reverse32(ols->trigger_value[3])) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_3, + reverse32(devc->trigger_value[3])) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_3, + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_3, trigger_config[3]) != SR_OK) return SR_ERR; } else { - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_MASK_0, - ols->trigger_mask[0]) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_MASK_0, + devc->trigger_mask[0]) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_VALUE_0, - ols->trigger_value[0]) != SR_OK) + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_VALUE_0, + devc->trigger_value[0]) != SR_OK) return SR_ERR; - if (send_longcommand(ols->serial->fd, CMD_SET_TRIGGER_CONFIG_0, + if (send_longcommand(devc->serial, CMD_SET_TRIGGER_CONFIG_0, 0x00000008) != SR_OK) return SR_ERR; delaycount = readcount; } - 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) + 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(ols->serial->fd, CMD_CAPTURE_SIZE, reverse16(data)) != SR_OK) + 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". */ - 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) + 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(ols->serial->fd, CMD_RUN) != SR_OK) + if (send_shortcommand(devc->serial, CMD_RUN) != SR_OK) return SR_ERR; - sr_source_add(ols->serial->fd, G_IO_IN, -1, receive_data, - session_data); + sr_source_add(devc->serial->fd, G_IO_IN, -1, receive_data, + cb_data); if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) { - sr_err("ols: %s: packet malloc failed", __func__); + sr_err("Datafeed packet malloc failed."); return SR_ERR_MALLOC; } if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) { - sr_err("ols: %s: header malloc failed", __func__); + sr_err("Datafeed header malloc failed."); g_free(packet); return SR_ERR_MALLOC; } @@ -1000,9 +1011,14 @@ static int hw_start_acquisition(int device_index, gpointer session_data) packet->payload = (unsigned char *)header; header->feed_version = 1; gettimeofday(&header->starttime, NULL); - header->samplerate = ols->cur_samplerate; - header->num_logic_probes = NUM_PROBES; - sr_session_bus(session_data, packet); + sr_session_send(cb_data, packet); + + /* Send metadata about the SR_DF_LOGIC packets to come. */ + packet->type = SR_DF_META_LOGIC; + packet->payload = &meta; + meta.samplerate = devc->cur_samplerate; + meta.num_probes = NUM_PROBES; + sr_session_send(cb_data, packet); g_free(header); g_free(packet); @@ -1010,31 +1026,31 @@ static int hw_start_acquisition(int device_index, gpointer session_data) return SR_OK; } -static int hw_stop_acquisition(int device_index, gpointer session_device_id) +/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */ +static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) { - struct sr_datafeed_packet packet; - /* Avoid compiler warnings. */ - (void)device_index; + (void)cb_data; - packet.type = SR_DF_END; - sr_session_bus(session_device_id, &packet); + abort_acquisition(sdi); return SR_OK; } -SR_PRIV struct sr_device_plugin ols_plugin_info = { +SR_PRIV struct sr_dev_driver ols_driver_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, + .scan = hw_scan, + .dev_list = hw_dev_list, + .dev_clear = hw_cleanup, + .dev_open = hw_dev_open, + .dev_close = hw_dev_close, + .info_get = hw_info_get, + .dev_config_set = hw_dev_config_set, + .dev_acquisition_start = hw_dev_acquisition_start, + .dev_acquisition_stop = hw_dev_acquisition_stop, + .priv = NULL, };